At DemocracyClub we value contributions to our projects from volunteers and contirbutors. Please read and follow our Code of Conduct.
- 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 and linters locally using:
pytest(unit tests)
- Check your work against our coding standards. We use ruff and and djhtml for linting and code formatting:
ruff check .(lint with ruff)ruff format .(auto-format with ruff)git ls-files '*.html' | xargs djhtml(auto-format templates with djhtml)
- 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.