Skip to content

Commit

Permalink
Merge pull request #56 from salty-ivy/fix/documentation-for-contribution
Browse files Browse the repository at this point in the history
Fix: add a simple developer documentation for new contributors
  • Loading branch information
Stormheg authored Aug 26, 2023
2 parents d04bd00 + 1248be7 commit 79b0390
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -267,3 +267,27 @@ addEventListener('fetch', event => {
Add a variable to the worker called ``WAGTAIL_AB_TESTING_WORKER_TOKEN``, giving it the same token value that you generated earlier.

Finally, add a route into Cloudflare so that it routes all traffic through this worker.

## Contribution

### Install

To make changes to this project, first fork this repository and clone it to your local system:

```shell
git clone link-to-your-forked-repo
cd wagtail-ab-testing
```

With your preferred virtualenv activated, install testing dependencies:


```shell
python -m pip install -e .[testing]
```

### How to run tests

```shell
python testmanage.py test
```

0 comments on commit 79b0390

Please sign in to comment.