Fix #226, Add Instructions on How to Squash and Amend Commits #237
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ArielSAdamsNASA
added
CCB:Ready
skliper
reviewed
Apr 6, 2021
CONTRIBUTING.md
Outdated
| @@ -90,12 +90,70 @@ Follow GitHub's fork-branch-pull request pattern. | |||
| 7. Provide your full name or GitHub username and your company or organization if applicable. | |||
|
|
|||
| #### Once a Pull Request Ready for Review | |||
| 1. Verify the commit message and PR title use the template `Fix #XYZ, SHORT_DESCRIPTION`. | |||
| 2. Verify there is only one commit message. Squash or amend the commit messages if necessary. | |||
| 1. Verify the commit message and PR title use the template `Fix #XYZ, SHORT_DESCRIPTION`. The commit message can use `Fix #XYZ, LONG_DESCRIPTION` if necessary. | |||
There was a problem hiding this comment.
Format is
Fix #XYZ, SHORT_DESCRIPTION
LONG_DESCRIPTION (optional)
There was a problem hiding this comment.
Updated format in sections Ready to Add Your Code?, Once a Pull Request Ready for Review, and Soft Reset.
CONTRIBUTING.md
Outdated
| #### How to Squash Commits | ||
| 1. Switch to the master branch and ensure you are up to date: | ||
| ```sh | ||
| git checkout master && git pull |
There was a problem hiding this comment.
Updated to main.
ArielSAdamsNASA
added
CCB:Ready
|
CCB:2021-04-07 APPROVED
|
Added reference under sections Ready to Add Your Code? and Once a Pull Request Ready for Review |
astrogeco
added
CCB:Approved
skliper
added
CCB:2021-04-07
and removed
CCB:Approved
astrogeco
approved these changes
Apr 22, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Checklist (Please check before submitting)
Describe the contribution
Fixes #226
Fix #XYZ, LONG_DESCRIPTIONfor commit messages if necessary.Expected behavior changes
Users should know how to squash and amend commits.
Contributor Info - All information REQUIRED for consideration of pull request
Ariel Adams, ASRC Federal