Contribution Workflow

Contribution Workflow

1. Set up Developer Environment

2. Claim an issue

Check our GitHub issues for anything that interests you. We have many labels you can search by, including a for-new-contributors label.

If there is no one assigned to the issue, you may claim it by commenting.

3. Sync forked repo

Fetch changes from the upstream master branch.

git checkout master
git fetch upstream master

Rebase local master with the upstream/master branch.

git rebase -i upstream/master

Push changes to origin master.

git push origin master

4. Create feature branch

Create a feature branch to work on your issue (in the format of XX-description where XX is the issue number).

git checkout -b 77-fix-person-not-found

5. Work on your issue

Test your changes frequently.

mvn test

Add and commit changes.

git add src/main/java/com/revature/controllers/PersonController.java

git commit -m "Fix response for person not found"

Push changes to your repository.

git push origin 77-fix-person-not-found

6. Before you create a pull request (PR)

Checkout your feature branch

git checkout 77-fix-person-not-found

Rebase from upstream

git fetch upstream master

git rebase -i upstream/master

Run tests

mvn test

Push changes to your repository

• (If it fails, you may need to force push by adding the -f flag.)

git push origin 77-fix-person-not-found

7. Create a PR

Go to your fork and create a PR.

base fork: 1701-jan09-java/interview-evaluations
base: master
head fork: your forked repo
compare: 77-fix-person-not-found

8. Review process

Status checks

The CI pipeline will do some analysis of your changes. All status checks must pass before the PR can be merged.

Review

Maintainers will review your code and may request further changes. Be active in the discussion to ensure a quick turnaround.