Thanks for taking the time to consider contributing to this project! There are a number of ways you can contribute to this project. Design, copywriting, translating, and coding are just a few of the ways you can help.
If you haven't already, come join the #code-for-kentuckiana channel in Code for America's Slack.
We'd love to hear how we can make the site easier to use. Reach out to us on the Code for America Slack to let us know your thoughts, and we can figure out the best way to move forward.
You can sign up to help us translate the Renter Haven site by signing up for a free account with our translation service: https://www.transifex.com/code-for-kentuckiana/renter-haven/
If you would like to help contrinute code, we welcome your submissions. Code includes Python, CSS, HTML, and/or JavaScript. Changes to improve accessibility are particularly welcome.
We're trying to maintain high test coverage on this project.
Please include Django test cases with your code.
You can run all tests by running make test from your command line.
Please send a GitHub Pull Request to renters-rights with a clear list of what you've done (read more about pull requests). Please follow our coding conventions (below) and make sure all of your commits are atomic (one feature per commit).
Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:
$ git commit -m "A brief summary of the commit
>
> A paragraph describing what changed and its impact."
If you're a new contributor, add your name to CONTRIBUTORS.txt!
Start reading our code and you'll get the hang of it. We optimize for readability:
- We use the black code formatter (run
make formator let the pre-commit hook format for you) - We use the Django test suite
(This document is based on https://github.com/opengovernment/opengovernment/blob/master/CONTRIBUTING.md)