CONTRIBUTING.md

Contributing to bughunter-cli

First off, thank you for considering contributing to bughunter-cli! It's people like you that make bughunter-cli such a great tool.

Where do I go from here?

If you've noticed a bug or have a feature request, make one! It's generally best if you get confirmation of your bug or approval for your feature request this way before starting to code.

Fork & create a branch

If this is something you think you can fix, then fork bughunter-cli and create a branch with a descriptive name.

A good branch name would be (where issue #123 is the ticket you're working on):

git checkout -b 123-fix-bug-description

Get the test suite running

Make sure you're running the test suite locally before you start making changes.

pytest

Implement your fix or feature

At this point, you're ready to make your changes! Feel free to ask for help; everyone is a beginner at first 😸

Make a Pull Request

At this point, you should switch back to your master branch and make sure it's up to date with bughunter-cli's master branch.

git remote add upstream git@github.com:akabarki76/bughunter-cli.git
git checkout master
git pull upstream master

Then update your feature branch from your local copy of master, and push it!

git checkout 123-fix-bug-description
git rebase master
git push --set-upstream origin 123-fix-bug-description

Finally, go to GitHub and make a Pull Request

Keeping your Pull Request updated

If a maintainer asks you to "rebase" your PR, they're saying that a lot of code has changed, and that you need to update your branch so it's easier to merge.

To learn more about rebasing and merging, check out this guide on syncing a fork.