[INFRA-227] JIRA workflow for PFS needs to be documented Created: 18/Oct/18 Updated: 14/Jul/19 Resolved: 14/Jul/19 |
|
| Status: | Done |
| Project: | Software Development Infrastructure |
| Component/s: | support |
| Affects Version/s: | None |
| Fix Version/s: | None |
| Type: | Story | Priority: | Normal |
| Reporter: | hassan | Assignee: | yuki.moritani |
| Resolution: | Done | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Issue Links: |
|
||||||||||||||||
| Description |
|
Presently I cannot see (but yuki.moritani correct me if I am wrong) specific documentation explaining the workflow for a JIRA ticket, and in particular in relation to GitHub Pull Requests and related reviews. The closest documentation I see is https://pfs-2d-pipeline.readthedocs.io/en/latest/dev/best_practice.html and https://github.com/Subaru-PFS/doc/blob/master/development-management/ticketing-jira.rst but both do not adequately document the workflow. This is important so that updates can be made to software in a controlled manner. |
| Comments |
| Comment by hassan [ 18/Oct/18 ] |
|
Initially assigned to yuki.moritani but I am happy to work with her on this matter. |
| Comment by yuki.moritani [ 18/Oct/18 ] |
|
hassan could you explain what is the difference from INFRA-226 ? |
| Comment by hassan [ 18/Oct/18 ] |
|
My understanding is that INFRA-226 is related to the guideline for branch naming, while this one is more general, covering issue transitions and policy regarding reviews and pull requests. I'm happy to include the above to INFRA-226 and resolve this if you prefer. |
| Comment by yuki.moritani [ 18/Oct/18 ] |
|
Thank you for explanation. I'd like to ask a question: in general you should work on one branch per one ticket? |
| Comment by hassan [ 18/Oct/18 ] |
|
This is a good point. It should be one branch per single ticket. But I also see for documentation it doesn't make sense to do multiple branches. I think you should simply make all the updates related to both tickets in a single branch, eg tickets/INFRA-226, and resolve this ticket referencing that branch. If you need help with the documentation, please tell me. |
| Comment by yuki.moritani [ 18/Oct/18 ] |
|
I see, then separate ticket is fine to me. Thank you for your suggestion. |