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.
-
Describe the contents and goal of the pull request.
-
Will coverge be maintained/increased?
-
What operating systems has this been tested on? How were these tests conducted?
-
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, Lauren Nevill, our Principal Software Engineer, Bergas Batara, and our Founding Engineer, Gregory Kapfhammer when you mark it as ready for review.