Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix: add a simple developer documentation for new contributors #56

Merged
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
```