mirror of
https://github.com/reactos/reactos.git
synced 2024-12-28 10:04:49 +00:00
[CONTRIBUTING] Add a commit template and a paragraph about it
This template defines a general commit style, and will be most helpful for newcomers. I will be using it personally :)
This commit is contained in:
parent
c54c5ebb5f
commit
d70741fa20
2 changed files with 28 additions and 0 deletions
23
.gitmessage
Normal file
23
.gitmessage
Normal file
|
@ -0,0 +1,23 @@
|
|||
# [MODULE] A short but descriptive summary (#pr-num)
|
||||
|
||||
# A comprehensible description of WHY you did this work.
|
||||
|
||||
# CORE-XXXX CIDXXXXX
|
||||
|
||||
#--------------------------------------------------------------------^
|
||||
# 70^
|
||||
# * [MODULE] should usually be the name of the CMake module, written
|
||||
# in all caps.
|
||||
#
|
||||
# * Summary should be imperative (not past tense), 70 characters or
|
||||
# less, and not end with a period.
|
||||
#
|
||||
# * Description of commit should explain WHY a change was made and
|
||||
# lines should be also wrapped to 70 characters.
|
||||
#
|
||||
# * JIRA, Coverity ID references should be placed at the bottom and
|
||||
# preceded by the newline.
|
||||
#
|
||||
# * Pull request should always be referenced in the summary in parens
|
||||
# unless it doesn't fit In this case it should be placed after bug
|
||||
# IDs if any.
|
|
@ -57,6 +57,10 @@ A __[patch]__ is a set of changes to existing source code. The changes in a patc
|
|||
|
||||
See [Submitting Patches] for details.
|
||||
|
||||
### Commit style
|
||||
|
||||
Our commit style is defined in a __[commit template]__. Use it as a reference or turn it on using `git config commit.template .gitmessage`. This will set this template as an initial commit message for the new commits in your local repository.
|
||||
|
||||
### Rules and Recommendations
|
||||
|
||||
- *Use your __real name__ and __real email__.* We do not accept anonymous contributions!
|
||||
|
@ -96,3 +100,4 @@ Finding a good project to start with can be a challenge, because when starting o
|
|||
[README.FSD]: /media/doc/README.FSD
|
||||
[Coverity]: https://scan.coverity.com/projects/reactos
|
||||
[request-coverity]: https://scan.coverity.com/memberships/new?project_id=reactos
|
||||
[commit template]: .gitmessage
|
||||
|
|
Loading…
Reference in a new issue