Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
You can contribute in many ways:
Types of Contributions¶
Report bugs at https://github.com/arfey/aiohttp_admin2/issues.
If you are reporting a bug, please include:
- Your operating system name and version.
- Any details about your local setup that might be helpful in troubleshooting.
- Detailed steps to reproduce the bug.
Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.
Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.
aiohttp admin 2 could always use more documentation, whether as part of the official aiohttp admin 2 docs, in docstrings, or even on the web in blog posts, articles, and such.
The best way to send feedback is to file an issue at https://github.com/arfey/aiohttp_admin2/issues.
If you are proposing a feature:
- Explain in detail how it would work.
- Keep the scope as narrow as possible, to make it easier to implement.
- Remember that this is a volunteer-driven project, and that contributions are welcome :)
Ready to contribute? Here’s how to set up aiohttp_admin2 for local development.
Fork the aiohttp_admin2 repo on GitHub.
Clone your fork locally:
$ git clone email@example.com:your_name_here/aiohttp_admin2.git
Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
$ mkvirtualenv aiohttp_admin2 $ cd aiohttp_admin2/ $ pip install requirements/develop.txt $ pip install -e .
Create a branch for local development:
$ git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
When you’re done making changes, check that your changes pass linters and tests:
$ make lint $ make test
Commit your changes and push your branch to GitHub:
$ git add . $ git commit -m "Your detailed description of your changes." $ git push origin name-of-your-bugfix-or-feature
Submit a pull request through the GitHub website.
To run a subset of tests:
$ pytest --slow -v -s -p no:warnings tests/resources/common_resource
Run some particular test:
$ pytest --slow -v -s -p no:warnings tests/resources/common_resource/test_create.py::test_create_with_error
All features you can to test in demo application.