Skip to content

Workflow for updates

kaydin edited this page Nov 6, 2024 · 7 revisions

Developer instructions:

  • Create a new task specific branch off dev

  • Implement your task in your branch. Ensure that you pull dev into your branch regularly.

  • Before creating a pull request back into dev ensure that your branch is otherwise up to date with dev

  • Create a pull request into dev and assign at least one reviewer.

  • Pull requests should explicitly state the issue addressed and the expected behavior from the changes. Please link the pull request to an Rpath issue where possible using the Development menu on the right hand side of the Pull Request screen.

Reviewer instructions:

  • Clone repo locally

  • Switch to task specific branch

  • Build Rpath locally from task specific branch

  • Test new feature locally to validate expected behavior

  • Run unit tests locally (instructions)

  • Evaluate whether unrelated behavior is still as expected (develop automated tests for this?)

  • Note any unexpected behavior, error messages, etc as specifically as possible in a review comment. Add code used or link to code used to test the feature in the review comment. If there is unexpected behavior, do not approve the pull request or pull it into dev

  • If all works as expected, note that in the review and click "approve" in the review panel

  • We may limit the ability to merge pull requests to a couple of people

After merging

  • Delete the task specific branch
Clone this wiki locally