Artemis PR Workflow

artemis_pr.md

So you want to contribute to artems?

step 0: pick and issue to address:

Issues tagged as help wanted and/or good first issue are a good place to start:

• Help Wanted

• Good First Issue

step 1: fork the repo:

navigate to the artemis repo in your browser: https://github.com/PegaSysEng/artemis

step 2: clone your forked version of the repo:

$ git clone [email protected]:jrhea/artemis.git

we now have artemis cloned locally and our origin is:

$ git remote -v
origin  [email protected]:jrhea/artemis.git (fetch)
origin  [email protected]:jrhea/artemis.git (push)

step 3: add artemis base repo as an upstream remote:

$ git remote add upstream [email protected]:PegaSysEng/artemis.git

we now have origin and upstream set like this:

$ git remote -v
origin  [email protected]:jrhea/artemis.git (fetch)
origin  [email protected]:jrhea/artemis.git (push)
upstream        [email protected]:PegaSysEng/artemis.git (fetch)
upstream        [email protected]:PegaSysEng/artemis.git (push)

step 4: checkout a new local branch, make changes and commit

$ git checkout -b feat-new_foo

make your changes then commit:

$ git add the/modified/file.java
$ git commit -m "this is what i did"

step 5: rebase from upstream/master

by the time you are ready to create your PR, the upstream/master could have been modified.
make sure your PR is compatible with any potential upstream changes.

$ git fetch upstream master
$ git rebase upstream/master

step 7: make sure everything still works

$ ./gradlew spotlessApply clean build test

step 6: push and open PR:

$ git push origin head

then open a new PR in the artemis repo here:

https://github.com/PegaSysEng/artemis