RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
Code Releases Activity

CONTRIBUTING: add example commit

Browse Source 
Add an example commit to the *commit conventions* section.
Refer to this in the pull request steps.
This commit is contained in:
Silke Hofstra 2020-10-03 15:16:27 +02:00
parent 1cadc95142
commit a34cba3307
1 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
CONTRIBUTING.md
View File

@ -129,6 +129,13 @@ It is possible to check if your code follows these conventions:
You can use multi-line commit messages if you want to detail more the You can use multi-line commit messages if you want to detail more the
changes. changes.
For example:
periph/timer: Document that set_absolute is expected to wrap
Most timers are implemented this way already, and keeping (documenting)
it that way allows the generic timer_set implementation to stay as
simple as it is.
### Pull Requests ### Pull Requests
[pull requests]: #pull-requests [pull requests]: #pull-requests
@ -148,9 +155,8 @@ into the source repository.
Old and stalled [PRs are sometimes archived][archived-pull-requests] with the Old and stalled [PRs are sometimes archived][archived-pull-requests] with the
"State: archived" label, maybe one of them is also about the same topic. "State: archived" label, maybe one of them is also about the same topic.
* The Pull Request title should reflect what it is about and be in the form: * The Pull Request title should reflect what it is about and be in the same form
as the [commit conventions].
area of change: description of changes
* Each Pull Request form uses a template that is there to help * Each Pull Request form uses a template that is there to help
maintainers understand your contribution and help them in testing it. maintainers understand your contribution and help them in testing it.