CONTRIBUTING.md

Contributing to Guard Dog

Getting Started

To open the development environment for Guard Dog: first make sure pip and pipenv are installed.

$ pip install pipenv

To install all dependencies for Guard Dog, open the virtual environment, and add the root of the repository to PYTHONPATH:

$ poetry install
$ poetry shell

To analyze Github repos (verify), make sure your Github username and Github API key are set up in environment variables named GIT_USERNAME and GH_TOKEN.

You're ready to start developing!

🐛 Creating Issues

If you found a bug, search if an issue already exists search if an issue already exists. If it doesn't, you can create a new issue with the bug label. Likewise, if you would like to suggest an enhancement, first see if a similar issue was already created. Then, create a new issue with the enhancement label.

✅ Solving Issues

Create a new branch with the form: <username>/<branch-function>. After changing the repo locally and pushing to your branch's remote origin, create a pull request with a short description of your changes.