Nulo/river
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

docs: update commit style guidelines

Browse source 
Require a prefix for commit messages as this makes the log much more
readable. Additionally, link Weston's contributing guidelines to
encourage "recipe style" history.
This commit is contained in:
Isaac Freund 2020-06-05 00:56:50 +02:00
parent 83d2a8be5f
commit a1f4123894
No known key found for this signature in database
GPG key ID: 86DED400DDFD7A11
1 changed files with 19 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
CONTRIBUTING.md
View file

@ -1,23 +1,35 @@
## Contributing to river ## Contributing to river
Contributing is a simple as opening a pull request on our github. You'll likely Contributing is a simple as opening a pull request on github. You'll likely
have more success with your contribution if you hop on our have more success with your contribution if you hop on our
[matrix channel](https://matrix.to/#/#river:matrix.org) to discuss your plans [matrix channel](https://matrix.to/#/#river:matrix.org) to discuss your plans
first. first.
## Commit messages ## Commit messages
Please take the time to write a good commit message, having a clean git history Please take the time to write a good commit message, having a clean git
makes maintaining and contributing to river easier. Commit messages should start history makes maintaining and contributing to river easier. Commit messages
with a summary in 50 characters or less. This summary should complete the should start with a prefix indicating what part of river is affected by the
sentence "When applied, this commit will...". change, followed by a brief summary.
For example:
```
build: scan river-status protocol
```
or
```
river-status: send view_tags on view map/unmap
```
In addition to the summary, feel free to add any other details you want preceded In addition to the summary, feel free to add any other details you want preceded
by a blank line. A good rule of thumb is that anything you would write in a pull by a blank line. A good rule of thumb is that anything you would write in a pull
request description on github has a place in the commit message as well. request description on github has a place in the commit message as well.
For more discussion and details of good commit message practices, check out For further details regarding commit style and git history see
[this post](https://chris.beams.io/posts/git-commit/). [weston's contributing guidelines](https://gitlab.freedesktop.org/wayland/weston/-/blob/master/CONTRIBUTING.md#formatting-and-separating-commits).
## Coding style ## Coding style