-
Notifications
You must be signed in to change notification settings - Fork 13
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Pr template #141
Pr template #141
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for helping out and creating this template for PostREISE. This will make the teams live easier.
I have two small things.
First, please follow the commit message standards we are using. See https://github.com/Breakthrough-Energy/REISE/wiki/Software-Development-Guidelines#semantic-commit-messages
Second, please hide the pull_request_template in the .github/ folder. You will have to create that folder.
33cadf8
to
841c811
Compare
@kasparm should the |
Your branch should be merged into develop. We don't use master. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good, thank you. Make sure to rebase before merging.
841c811
to
f2c8b16
Compare
* feat: add a template to automatically formate PRs
Purpose
To add a template to each PR to reduce the need of copy/pasting the summary text
What the code is doing
Each time a PR is created a code author will see:
*Pre-populated PR headers with explanation text inspired by the screenshot found in the PR Etiquette cheat sheet
*Adds a testing section. I think adding this section is helpful because it shows how we are maintaining our code and also shows reviewers how they can replicate testing if they desire.
Testing
This has been added to the CENACS repo as well.
Where to look
This file will live at the root directory of this repo.
Usage Example/Visuals
N/A
Time estimate
~5min or less. Feedback is welcome! Specifically on whether or not this is useful. Also, I'm not committed to any of the example text. I'm open to changing any of the text and adding/removing info.