Github allows you to create standardized Issue and PR templates. I think it would be a good idea to come up with some basic templates for this repo. Wondering if it would be cool to actually make a modified SBAR format for this. These would be defaults but can still be adjusted in the issue or PR.
Templates I have seen in the past look like this (shout out to @toozej):
For issues:
Problem Statement
[What needs to be done and why]
Criteria for Success
[Measureable outcome if possible]
Additional Information
[ways one might accomplish this task, links, documentation, alternatives, etc.]
For PRs:
Fixes org/repo#ISSUE_NUMBER
Explanation
[What did you change?]
Rationale
[Why did you make the changes mentioned above? What alternatives did you consider?]
Github allows you to create standardized Issue and PR templates. I think it would be a good idea to come up with some basic templates for this repo. Wondering if it would be cool to actually make a modified SBAR format for this. These would be defaults but can still be adjusted in the issue or PR.
Templates I have seen in the past look like this (shout out to @toozej):
For issues:
Problem Statement
[What needs to be done and why]
Criteria for Success
[Measureable outcome if possible]
Additional Information
[ways one might accomplish this task, links, documentation, alternatives, etc.]
For PRs:
Fixes org/repo#ISSUE_NUMBER
Explanation
[What did you change?]
Rationale
[Why did you make the changes mentioned above? What alternatives did you consider?]
Tests
testing logs
``` ```