Skip to content

Commit a571e10

Browse files
authored
FIX-#2258: return 'Commit Message formatting' topic (#2306)
Signed-off-by: Anatoly Myachev <[email protected]>
1 parent e685b8d commit a571e10

File tree

2 files changed

+23
-1
lines changed

2 files changed

+23
-1
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ if you have questions about contributing.
88

99
<!-- Please give a short brief about these changes. -->
1010

11-
- [ ] commit message follows format outlined [here](https://modin.readthedocs.io/en/latest/contributing.html)
11+
- [ ] commit message follows format outlined [here](https://modin.readthedocs.io/en/latest/developer/contributing.html)
1212
- [ ] passes `flake8 modin`
1313
- [ ] passes `black --check modin`
1414
- [ ] signed commit with `git commit -s` <!-- you can amend your commit with a signature via `git commit -amend -s` -->

docs/developer/contributing.rst

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,28 @@ commits and push them to GitHub.
8282
If you've pushed your changes to GitHub already you'll need to force push your branch
8383
after this with ``git push -f``.
8484

85+
Commit Message formatting
86+
-------------------------
87+
To ensure that all commit messages in the master branch follow a specific format, we
88+
enforce that all commit messages must follow the following format:
89+
90+
.. code-block:: bash
91+
FEAT-#9999: Add `DataFrame.rolling` functionality, to enable rolling window operations
92+
The ``FEAT`` component represents the type of commit. This component of the commit
93+
message can be one of the following:
94+
95+
* FEAT: A new feature that is added
96+
* DOCS: Documentation improvements or updates
97+
* FIX: A bugfix contribution
98+
* REFACTOR: Moving or removing code without change in functionality
99+
* TEST: Test updates or improvements
100+
101+
The ``#9999`` component of the commit message should be the issue number in the Modin
102+
GitHub issue tracker: https://github.com/modin-project/modin/issues. This is important
103+
because it links commits to their issues.
104+
105+
The commit message should follow a colon (:) and be descriptive and succinct.
106+
85107
Development Dependencies
86108
------------------------
87109

0 commit comments

Comments
 (0)