mirror of
https://github.com/uutils/coreutils
synced 2024-11-15 17:28:03 +00:00
Merge pull request #852 from jbcrail/contributing-commit-msgs
CONTRIBUTING: add guidelines for commit msgs
This commit is contained in:
commit
183224db15
1 changed files with 65 additions and 3 deletions
|
@ -1,5 +1,4 @@
|
||||||
Contributing to coreutils
|
# Contributing to coreutils
|
||||||
=========================
|
|
||||||
|
|
||||||
Contributions are very welcome, and should target Rust's master branch until the
|
Contributions are very welcome, and should target Rust's master branch until the
|
||||||
standard libraries are stabilized. You may *claim* an item on the to-do list by
|
standard libraries are stabilized. You may *claim* an item on the to-do list by
|
||||||
|
@ -13,4 +12,67 @@ following these steps:
|
||||||
6. Remove utility from the to-do list in the README.
|
6. Remove utility from the to-do list in the README.
|
||||||
7. Submit a pull request and close the issue.
|
7. Submit a pull request and close the issue.
|
||||||
|
|
||||||
The steps above imply that, before starting to work on a utility, you should search the issues to make sure no one else is working on it.
|
The steps above imply that, before starting to work on a utility, you should
|
||||||
|
search the issues to make sure no one else is working on it.
|
||||||
|
|
||||||
|
## Commit messages
|
||||||
|
|
||||||
|
To help the project maintainers review pull requests from contributors across
|
||||||
|
numerous utilites, the team has settled on conventions for commit messages.
|
||||||
|
|
||||||
|
From http://git-scm.com/book/ch5-2.html:
|
||||||
|
|
||||||
|
```
|
||||||
|
Short (50 chars or less) summary of changes
|
||||||
|
|
||||||
|
More detailed explanatory text, if necessary. Wrap it to about 72
|
||||||
|
characters or so. In some contexts, the first line is treated as the
|
||||||
|
subject of an email and the rest of the text as the body. The blank
|
||||||
|
line separating the summary from the body is critical (unless you omit
|
||||||
|
the body entirely); tools like rebase can get confused if you run the
|
||||||
|
two together.
|
||||||
|
|
||||||
|
Further paragraphs come after blank lines.
|
||||||
|
|
||||||
|
- Bullet points are okay, too
|
||||||
|
|
||||||
|
- Typically a hyphen or asterisk is used for the bullet, preceded by a
|
||||||
|
single space, with blank lines in between, but conventions vary here
|
||||||
|
```
|
||||||
|
|
||||||
|
Furthermore, here are a few examples for a summary line:
|
||||||
|
|
||||||
|
* commit for a single utility
|
||||||
|
|
||||||
|
```
|
||||||
|
nohup: cleanup and refactor
|
||||||
|
```
|
||||||
|
|
||||||
|
* commit for a utility's tests
|
||||||
|
|
||||||
|
```
|
||||||
|
tests/rm: test new feature
|
||||||
|
```
|
||||||
|
|
||||||
|
Beyond changes to an individual utility or its tests, other summary
|
||||||
|
lines for non-utility modules include:
|
||||||
|
|
||||||
|
```
|
||||||
|
README: add help
|
||||||
|
```
|
||||||
|
|
||||||
|
```
|
||||||
|
travis: fix build
|
||||||
|
```
|
||||||
|
|
||||||
|
```
|
||||||
|
uucore: add new modules
|
||||||
|
```
|
||||||
|
|
||||||
|
```
|
||||||
|
uutils: add new utility
|
||||||
|
```
|
||||||
|
|
||||||
|
```
|
||||||
|
gitignore: add temporary files
|
||||||
|
```
|
||||||
|
|
Loading…
Reference in a new issue