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

Add a simple developer documentation for new contributors #55

Closed
salty-ivy opened this issue Aug 12, 2023 · 0 comments · Fixed by #56
Closed

Add a simple developer documentation for new contributors #55

salty-ivy opened this issue Aug 12, 2023 · 0 comments · Fixed by #56

Comments

@salty-ivy
Copy link
Contributor

salty-ivy commented Aug 12, 2023

          @salty-ivy running the tests is not that well documented in the readme, here is how I did it.

Assuming you are inside a virtualenv

# Install wagtail-ab-testing in editable mode along with its testing dependencies
pip install -e ".[testing]"

# Run the tests
python testmanage.py test

Originally posted by @Stormheg in #53 (comment)

Cc: @Stormheg

We should add small developer section in readme.

that should at least documents how to install the repo locally and runtests.

this would include this repo to the scope of new upcoming contributors.

@salty-ivy salty-ivy changed the title @salty-ivy running the tests is not that well documented in the readme, here is how I did it. Add a simple developer documentation for new contributors Aug 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant