Skip to content

Latest commit

 

History

History
86 lines (59 loc) · 2.42 KB

CONTRIBUTING.md

File metadata and controls

86 lines (59 loc) · 2.42 KB

Contributing

First off, thank you for considering contributing to QuizApp.

1. Where do I go from here?

If you've noticed a bug or have a question that doesn't belong on the search the issue tracker to see if someone else in the community has already created a ticket. If not, go ahead and make one!

2. Fork & create a branch

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

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

for bug/issue fix

git checkout -b 123-add-progress-bar

For new feature

git checkout -b new-feature-name

3. Did you find a bug?

  • Ensure the bug was not already reported by searching all issues.

  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible.

4. 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 😸

5. Make a Pull Request

At this point, you should switch back to your master branch and make sure it's up to date with QuizApp's master branch:

git remote add upstream git@github.com:andy1729/QuizApp.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-add-progress-bar
git rebase master
git push --set-upstream origin 123-add-progress-bar

Finally, go to GitHub and make a Pull Request :D

6. 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 in Git, there are a lot of good resources, but here's the suggested workflow:

git checkout 123-add-progress-bar
git pull --rebase upstream master
git push --force-with-lease 123-add-progress-bar