Skip to content

Update documentation for PR standards #1573

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

Merged
WalterKolczynski-NOAA merged 2 commits into from
May 5, 2023
Merged

Update documentation for PR standards #1573

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
243903a
Update documentation for PR standards
WalterKolczynski-NOAA May 4, 2023
0468858
Fix typo in docs, expand a bit
WalterKolczynski-NOAA May 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions docs/source/development.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,21 +92,21 @@ All new code after 2022 Sep 1 will be required to meet these standards. We will

.. _commit-standards:

========================
Commit message standards
========================
======================
Pull request standards
======================

**ALL** commits must follow best practices for commit messages: https://chris.beams.io/posts/git-commit/
Pull requests should follow the pre-filled template provided when you open the PR. PR titles and descriptions become the commit message when the PR is squashed and merged, so we ask that they follow best practices for commit messages:

* Separate subject from body with a blank line
* Limit the subject line to 50 characters
* Limit the subject line (PR title) to 50 characters
* Capitalize the subject line
* Do not end the subject line with a period
* Use the `imperative mood <https://en.wikipedia.org/wiki/Imperative_mood>`_ in the subject line
* Wrap the body at 72 characters
* Use the body to explain what and why vs. how
* The final line of the commit message should include tags to relevant issues (e.g. ``Refs: #217, #300``)

This list is a modified version of the one provided at https://chris.beams.io/posts/git-commit/ with a couple removed that are not relevant to GitHub PRs. That source also provides the motivation for making sure we have good commit messages.

Here is the example commit message from the article linked above; it includes descriptions of what would be in each part of the commit message for guidance:

::
Expand Down