File tree Expand file tree Collapse file tree 2 files changed +23
-1
lines changed Expand file tree Collapse file tree 2 files changed +23
-1
lines changed Original file line number Diff line number Diff line change @@ -8,7 +8,7 @@ if you have questions about contributing.
8
8
9
9
<!-- Please give a short brief about these changes. -->
10
10
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 )
12
12
- [ ] passes ` flake8 modin `
13
13
- [ ] passes ` black --check modin `
14
14
- [ ] signed commit with ` git commit -s ` <!-- you can amend your commit with a signature via `git commit -amend -s` -->
Original file line number Diff line number Diff line change @@ -82,6 +82,28 @@ commits and push them to GitHub.
82
82
If you've pushed your changes to GitHub already you'll need to force push your branch
83
83
after this with ``git push -f ``.
84
84
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
+
85
107
Development Dependencies
86
108
------------------------
87
109
You can’t perform that action at this time.
0 commit comments