Skip to content

Editing VO

jie zheng edited this page Apr 17, 2024 · 5 revisions

Start from a local copy of the master branch of the VO repository. Make sure your local copy is up-to-date. Make your changes on a new branch.

When you're ready, push your branch to the VO repository and make a Pull Request (PR) on the GitHub website. The PR will be tested, discussed, adjusted if necessary, then merged.

Here are the steps with their CLI commands.

  1. git fetch make sure your local copy is up-to-date
  2. git checkout master start on the master branch
  3. git checkout -b your-branch-name create a new branch named for the change you're making
  4. make your changes in branch
  5. git status and git diff inspect your changes
  6. git add --update add all updated files to stage or using git add your-changed-file to stage a specific file
  7. git commit -m "Description, issue #123" commit staged changes with a message; it's good to include an issue number
  8. git push --set-upstream origin your-branch-name push your commit to GitHub
  9. open https://github.com/vaccineontology/VO in your browser and click the "Make Pull Request" button
  10. It's good to assign a VO developer to review the changes.

When that review is complete, the changes (PR) will be merged to the main branch.

Clone this wiki locally