Skip to content
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

Merged
merged 2 commits into from
Sep 24, 2020
Merged

Pr template #141

merged 2 commits into from
Sep 24, 2020

Conversation

kamilahjae
Copy link
Contributor

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:

  • A link to the PR etiquette doc
    *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.

@kamilahjae kamilahjae self-assigned this Aug 21, 2020
@kamilahjae kamilahjae requested a review from kasparm August 21, 2020 21:48
Copy link
Contributor

@kasparm kasparm left a 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.

@kamilahjae kamilahjae force-pushed the pull_request_template branch 3 times, most recently from 33cadf8 to 841c811 Compare September 21, 2020 19:38
@kamilahjae
Copy link
Contributor Author

@kasparm should the develop or master branch be rebased into this one? I rebased develop into this feature branch, but realized this PR is to merge into master. I think this could pose problems, no?

@rouille
Copy link
Collaborator

rouille commented Sep 22, 2020

@kasparm should the develop or master branch be rebased into this one? I rebased develop into this feature branch, but realized this PR is to merge into master. I think this could pose problems, no?

Your branch should be merged into develop. We don't use master.

@kamilahjae kamilahjae changed the base branch from master to develop September 22, 2020 17:46
@kasparm kasparm self-requested a review September 24, 2020 04:31
Copy link
Contributor

@kasparm kasparm left a 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.

@kamilahjae kamilahjae force-pushed the pull_request_template branch from 841c811 to f2c8b16 Compare September 24, 2020 16:25
@kamilahjae kamilahjae merged commit a039a92 into develop Sep 24, 2020
@kamilahjae kamilahjae deleted the pull_request_template branch September 24, 2020 16:33
rouille pushed a commit that referenced this pull request Oct 1, 2020
* feat: add a template to automatically formate PRs
@ahurli ahurli mentioned this pull request Mar 16, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants