When creating a pull request to add a new feature or alter an existing one,
there are some important elements to include to help our team review and process it more efficiently.
Make sure the title is descriptive of what the PR includes. Don't mention issue names/numbers; save that for the description.
List the names of those who contributed to the project.
Link the issue the pull request is meant to fix/resolve.
Add all labels that apply. (e.g. documentation, ready-for-review)
Describe the contents and goal of the pull request.
The issue templates were not working. I found the issue was that the folder was not the correct name or case.
Will coverage be maintained/increased?
Coverage will not be effected.
What operating systems has this been tested on? How were these tests conducted?
I am unable to test this without merging to the master branch.
Include a code block and/or screenshots displaying the functionality of your feature, if applicable/possible.
Mark as a draft until it is ready to begin the reviewing process, then tag our Lead Software Architect,
Jeff Normile, our Founding Engineer, Gregory Kapfhammer,
and our Project Managers, Haylee Pierce and Sabrina Rodriguez
when you mark it as ready for review.
When creating a pull request to add a new feature or alter an existing one, there are some important elements to include to help our team review and process it more efficiently.
Make sure the title is descriptive of what the PR includes. Don't mention issue names/numbers; save that for the description.
List the names of those who contributed to the project.
Link the issue the pull request is meant to fix/resolve.
Add all labels that apply. (e.g. documentation, ready-for-review)
Describe the contents and goal of the pull request. The issue templates were not working. I found the issue was that the folder was not the correct name or case.
Will coverage be maintained/increased? Coverage will not be effected.
What operating systems has this been tested on? How were these tests conducted? I am unable to test this without merging to the master branch.
Include a code block and/or screenshots displaying the functionality of your feature, if applicable/possible.
Mark as a draft until it is ready to begin the reviewing process, then tag our Lead Software Architect, Jeff Normile, our Founding Engineer, Gregory Kapfhammer, and our Project Managers, Haylee Pierce and Sabrina Rodriguez when you mark it as ready for review.