CONTRIBUTING.md

Contributing to Police Misconduct Data Collaborative

• Contributing to Police Misconduct Data Collaborative
  • Code of Conduct
  • Issues and Feature Requests
  • If You're New to Open Source
  • Git Flow
  • Making Pull Requests
  • Python Code Contributions
    • Style guide:
    • Before you submit a pull request:

Code of Conduct

The Police Misconduct Data Collaborative project has a Code of Conduct to which all contributors must adhere.

Issues and Feature Requests

• If you have a feature request or but report, our issues page is where to go to place those.
• If you think that you've found a bug in the application, first be certain that you're testing against the most recent version of the application available on the main repo. If not, search our issues list on GitHub in case a similar issue has already been opened.

If You're New to Open Source

If you're brand new to Git and/or GitHub, you'll want to familiarize yourself with the basics of version control, which you can do with Github's Hello World tutorial.

Git Flow

Project flow will work like this:

1. You'll make a clone of the main branch of the repo on your local machine, and fork a copy of the main repo to your GitHub account.

2. You'll push any changes made on your local project to the forked version on your GitHub account, and then open a pull request from your forked repo to the main repo.

Making Pull Requests

Pull requests are merged into our main branch. This makes main our main development branch. You'll want to keep your fork and local repo current with this branch so you're always working off the latest code. To do so, run these commands:

git checkout main
git pull upstream main
git push origin main

Python Code Contributions

Style guide:

• Use PEP-8 above everything. We adhere to 80 line limits and 4 space indents.
• Also use the Google Style Guide.

Before you submit a pull request:

• Run backend tests with python -m pytest
• Run flake8 with flake8 backend/. If flake8 gives you any trouble, you can run black backend/ to prettify your code automatically or use # noqa comments sparingly if you are absolutely sure a line of code is fine.