At DemocracyClub we value contributions to our projects from volunteers and contirbutors. Please read and follow our Code of Conduct.
If you are interested in helping out, feel free to contact us
- To report a bug or suggest an improvement, create an issue.
- Clearly describe the issue including steps to reproduce if it is a bug
- If you are interested in helping out, issues tagged as recommended for beginners or help wanted are the best place to start.
- Fork the repository on GitHub.
- Create a topic branch on your fork of the repository.
- Make commits of logical units.
- Use descriptive commit messages.
- Check your work against our test suite. You can run tests locally using:
pytest - Push your changes to a topic branch in your fork of the repository.
- Submit a pull request to the repository.
- Reference the #issue number in your pull request.
- Keep pull requests limited to a single issue.
- Test any front-end changes (HTML, CSS, javascript) in multiple browsers.
- We use Ruff coding standard. Please
run
ruffandruff formatbefore submitting a pull request