Skip to content

Latest commit

 

History

History
79 lines (71 loc) · 2.31 KB

contributor-guide.adoc

File metadata and controls

79 lines (71 loc) · 2.31 KB
Raw

Contributing to the documentation

The following guide walks you through contributing to the OpenJDK documentation.

Getting started

Before you begin you need to:

Contributing to the documentation

Once you have your local repository set up and have up to date copies of upstream content you need to follow these steps to contribute to the documentation.

Procedure

  1. Open your terminal

  2. cd to the directory where your documentation resides

  3. Checkout the master branch

    $ git checkout master

  4. Update your local repository and fork with the upstream content

    $ git pull upstream master
$ git push origin master --force

  5. Create a new branch for your work (using the issue number is helpful)

    $ git checkout -b <branch-name>

  6. Make your edits in the editor of your choice

  7. Save your changes locally

  8. If you are creating new files, add the files to the repository

    $ git status
$ git add <file-name>

  9. Commit your changes

    $ git commit -a -m "<message>"

  10. Push your changes to your fork

    $ git push origin HEAD

  11. If the update is rejected because the commit is behind, merge your changes

    $ git pull upstream master
$ git push -f origin HEAD

  12. Visit your fork on GitHub

  13. Click Compare & pull request

  14. If a SME review is needed:

    1. Add SME Review Needed label.

    2. When SME review is complete, remove SME Review Completed label and go to step 16.

  15. Add Peer Review Needed label and assign a Reviewer.

    1. When peer review has been completed, the reviewer deletes the Peer Review Needed label and adds the Peer Review Done label.

  16. When Peer Review Done label has been added:

    1. If no changes are needed, remove Peer Review Done label and add Ready for Merge label.

    2. If changes are needed and the changes are minor, make changes to the files, commit, and push, and then remove Peer Review Done label and add Ready for Merge label.

    3. If you want an additional review on the updated content, add the Peer Review Needed label and ask for another review in a comment.