Github issue tracking - HopkinsIDD/cholera-mapping-pipeline GitHub Wiki

1 Dec 2022

We will begin using GH issues to track bugs and enhancements that are identified in our line-by-line review of dev_staninput_refactor branch.

  1. Create a new GH issue with the tags "old pipeline" and "bug" or "enhancement" (as appropriate).
  2. Add the issue to the milestone entitled "Cease development on old pipeline".
  3. Describe the issue or suggestion in detail and add a permalink to the place in the code (on the correct branch!) where the changes should be made. To find the permalink, navigate to the line on Github in your internet browser, click on the line number, click on the button that appears with 3 horizontal dots, and select "Copy permalink".

Resolving an issue:

  1. Assign yourself to the GH issue you are working on.
  2. Make the changes in a branch off dev_staninput_refactor.
  3. Submit a PR of the branch with changes into dev_staninput_refactor.
  4. Add a comment to the PR with a link to the issue it is resolving and explain what you did.
  5. Ping Elizabeth or Javier to review the PR and merge the branch.

We will also use these GH issues to identify things that need to be checked in the new pipeline. If you resolve a GH issue for the old pipeline,

  1. If you believe it is something that should be checked in the new pipeline (or if you're not sure), replace the "old pipeline" tag with a "new pipeline" tag and add a comment that the issue was resolved in the old pipeline. Change the milestone to "Prepare new pipeline for ...".
  2. If the issue is not something that needs to be checked in the new pipeline, add a comment about what you did and close the issue.