GitHub Issue Tracking

The following process relates to all work that results in contribution to any of the projects in vivo-project GitHub organization. This process details the interaction between the VIVO GitHub issue tracker and GitHub pull-requests.

1. Create a GitHub issue/ticket
   • There are templates for reporting bug and definition of a new feature
   • Initially, it is in the "Open" state
   • Committers will be notified and can add labels to the issue/ticket
2. Assign yourself to the issue/ticket (see: Assignee field)
3. Start work on the issue/ticket
   • Create a git branch for the work (often times named: vivo-1234, where 1234 is the GitHub issue identifier)
4. When work is ready for review...
   • Push git branch to your GitHub fork, and create a pull-request to vivo-project
   • There are templates for pull-requests
   • Add link to your pull-request as a comment in the GitHub issue/ticket
5. Review will happen..
   • If all is well:
     • The pull-request will be merged
     • The issue/ticket should be "Closed", and a link to the pull-requests should be added as a comment in the issue/ticket
   • If there are code review comments/requests:
     • Comments will be made in GitHub, on your pull-request
     • Make updates to your vivo-1234 branch, adding another commit which will automatically update your pull-request
     • Follow steps detailed in "When work is ready for review..."