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.

Sign up for GitHub

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

Jump to bottom

Adding good commit message practices #549

Merged
merged 1 commit into from
Jan 27, 2022
Merged

Adding good commit message practices #549

merged 1 commit into from
Jan 27, 2022

Conversation

john-science
Copy link
Member

Description

The ARMI team and ecosystem have had "good commit" practices in place for years. But they haven't been written down for public consumption. This PR adds that guidance to the docs, and also as a bullet point to the default PR template.

Checklist

  • The code is understandable and maintainable to people beyond the author.
  • Tests have been added/updated to verify that the new or changed code works.
  • There is no commented out code in this PR.
  • The commit message follows good practices.
  • All docstrings are still up-to-date with these changes.

If user exposed functionality was added/changed:

  • Documentation added/updated in the doc folder.
  • New or updated dependencies have been added to setup.py.

@john-science john-science added the enhancement New feature or request label Jan 25, 2022
@jakehader jakehader merged commit 228d269 into terrapower:master Jan 27, 2022
@john-science john-science deleted the git_commit_guidelines branch January 27, 2022 14:35
scottyak pushed a commit to scottyak/armi that referenced this pull request Oct 27, 2022
@john-science @scottyak
Adding good commit message practices (terrapower#549)
0aece82
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jakehader jakehader jakehader approved these changes

@ntouran ntouran Awaiting requested review from ntouran

Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@john-science @jakehader