Making your contribution

Ensure you have properly setup the bugbug repository on your computer. Please see #3338 if you would like to know how to properly setup the repository on your computer.

1. Synchronize any changes that could have occurred before you start working on any contributions.

git checkout main
git fetch upstream
git merge upstream/main

2. Create a branch which you shall use to make your changes/add your contribution. First time contributors can start with Issues marked as good-first-bug. Issues are considered not assigned, until there is a PR linked to them. Feel free to work on any unassigned issue, you don't need to ask first. Remember to always use a feature_branch to make your changes. It's good practice to never work on the main/master branch.

git checkout -b my_feature_branch_name

3. Confirm you have pre-commit installed on your working environment by running:

pre-commit -V #Output should be pre-commit version

• pre-commit runs checks on your code before a commit thus improves the quality of commits. It should have been installed when you ran the command pip install -r test-requirements.txt from the Setup and Prerequisities in README.md

4. Make your changes on your feature branch and when you are done editing, add the changed files and commit them.

git add modified_file
git commit -m "Type a nice commit message"

• pre-commit will run code style checks whenever you commit your changes and if all checks have passed, the commit will complete.

5. Push the changes to your forked repository (origin) on your GitHub Account:

git push -u origin my_feature_branch_name

6. Make a pull request on Github. You can follow this guide on how to make a pull request from a forked repository. Please also see Submitting a Pull Request (PR) #3340 on how to submit your pull request to bugbug