Skip to content

Latest commit

 

History

History
23 lines (20 loc) · 1.44 KB

CONTRIBUTING.md

File metadata and controls

23 lines (20 loc) · 1.44 KB
Raw

Contributing

At Democracy Club we value contributions to our projects from volunteers and contributors. Please read and follow our Code of Conduct.

Issues

  • To report a bug or suggest an improvement, create an issue.
  • Clearly describe the issue including steps to reproduce if it is a bug.

Pull Requests

  • If you are interested in helping out, issues tagged as ready 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:
    • python manage.py test (unit tests) and
    • python manage.py harvest (acceptance tests) or enable Travis CI for your fork, so the tests will be executed after a push.
  • 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.