Submitting a Pull Request (PR)

[jpangas]

How can I submit a PR? What should I follow before submitting the PR and is there anything else I should do after submitting the Pull Request?

[jpangas]

Checklist when submitting your PR

1. The PR needs to be approved by the bugbug maintainers. In order to ease the review process, it is recommended you follow these principles:

• Let the PR have a helpful title and descriptive body.
• Link your PR to the issue it is solving, closing or resolving using Fixes/Closes/Resolves #PRNumber
• Ensure your changes have produced no code style or linting errors. pre-commit will run these checks. If any issues are found, the tests will fail.

After submitting your PR

2. Allow time for the reviewer to review your changes and if any further changes are needed, make and commit those changes to the same feature_name_branch.

The bugbug maintainers will check the changes, and if everything is looking good, they will approve and merge the changes to the main branch of the bugbug repository.

3. After the changes have been merged, to the bugbug master repository, you can delete the feature_branch on your forked repository. Checkout to the main (sometimes called master) branch on your machine and then pull the latest changes.

git checkout main
git fetch upstream
git merge upstream/main

5. Sync the updated main on your machine back to your fork.

git push -u origin main

6. You are free to work on any other issue and/or make further contributions.

For further assistance or discussions:

Chat with us in the bugbug Matrix room.