Skip to content

Fix #226, Add Instructions on How to Squash and Amend Commits#237

Merged
astrogeco merged 1 commit into
nasa:mainfrom
ArielSAdamsNASA:fix-226-add-instructions-to-squash-amend-commits
Apr 22, 2021
Merged

Fix #226, Add Instructions on How to Squash and Amend Commits#237
astrogeco merged 1 commit into
nasa:mainfrom
ArielSAdamsNASA:fix-226-add-instructions-to-squash-amend-commits

Conversation

@ArielSAdamsNASA

@ArielSAdamsNASA ArielSAdamsNASA commented Apr 6, 2021

Copy link
Copy Markdown
Contributor

Checklist (Please check before submitting)

Describe the contribution
Fixes #226

  • Added How to Squash Commits.
  • Added How to Amend Commits.
  • Added that users may use the format Fix #XYZ, LONG_DESCRIPTION for commit messages if necessary.
  • Added to create a commit message per topic and provided an example.
  • Added reference to https://chris.beams.io/posts/git-commit/

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

@ArielSAdamsNASA ArielSAdamsNASA added CCB:Ready Pull request is ready for discussion at the Configuration Control Board (CCB) docs labels Apr 6, 2021
Comment thread CONTRIBUTING.md Outdated
#### 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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Format is

Fix #XYZ, SHORT_DESCRIPTION

LONG_DESCRIPTION (optional)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated format in sections Ready to Add Your Code?, Once a Pull Request Ready for Review, and Soft Reset.

Comment thread 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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

main

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated to main.

Comment thread CONTRIBUTING.md
Comment thread CONTRIBUTING.md
@ArielSAdamsNASA ArielSAdamsNASA added CCB:Ready Pull request is ready for discussion at the Configuration Control Board (CCB) and removed CCB:Ready Pull request is ready for discussion at the Configuration Control Board (CCB) labels Apr 7, 2021
@astrogeco

Copy link
Copy Markdown
Contributor

CCB:2021-04-07 APPROVED

@ArielSAdamsNASA

Copy link
Copy Markdown
Contributor Author

CCB:2021-04-07 APPROVED

Added reference under sections Ready to Add Your Code? and Once a Pull Request Ready for Review

@astrogeco astrogeco added CCB:Approved Indicates code review and approval by community CCB and removed CCB:Ready Pull request is ready for discussion at the Configuration Control Board (CCB) labels Apr 7, 2021
@skliper skliper added CCB:2021-04-07 and removed CCB:Approved Indicates code review and approval by community CCB labels Apr 14, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add links or instructions to pull request squash and ammend section

4 participants