Skip to content

Commit

Permalink
CONTRIBUTING: add example commit
Browse files Browse the repository at this point in the history
Add an example commit to the *commit conventions* section.
Refer to this in the pull request steps.
  • Loading branch information
silkeh committed Oct 20, 2020
1 parent 1cadc95 commit a34cba3
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
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
Expand All @@ -148,9 +155,8 @@ into the source repository.
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.

* The Pull Request title should reflect what it is about and be in the form:

area of change: description of changes
* The Pull Request title should reflect what it is about and be in the same form
as the [commit conventions].

* Each Pull Request form uses a template that is there to help
maintainers understand your contribution and help them in testing it.
Expand Down

0 comments on commit a34cba3

Please sign in to comment.