Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
35 lines (25 loc) · 1.74 KB

CONTRIBUTING.md

File metadata and controls

35 lines (25 loc) · 1.74 KB

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.

Commit Signing

All commits must be signed. The repository requires commit signature verification on the main branch. Configure your local environment with GPG or SSH signing before pushing:

# Using SSH signing (recommended)
git config --global gpg.format ssh
git config --global user.signingkey ~/.ssh/id_ed25519.pub
git config --global commit.gpgsign true
⚡