Skip to content

Commit

Permalink
Add DCO and commit good practices (#88)
Browse files Browse the repository at this point in the history
Related to #38.

Also fixes:
- Link in pull request template.
- Adds dot at end of lines in issue templates.

Signed-off-by: Ivan Santiago Paunovic <[email protected]>
  • Loading branch information
ivanpauno authored Jan 27, 2023
1 parent 7fc4658 commit 4cbcda4
Show file tree
Hide file tree
Showing 4 changed files with 33 additions and 3 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Bug Report
about: Report a bug in beluga
about: Report a bug in beluga.
title: ''
labels: bug

Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Feature Request
about: Request a new feature for beluga
about: Request a new feature for beluga.
title: ''
labels: enhancement

Expand Down
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ NOTE: The larger description should be done in the linked issue, not here.
-->

## Checklist
- [ ] Read the [contributing guidelines](../CONTRIBUTING.md).
- [ ] Read the [contributing guidelines](https://github.com/ekumenlabs/beluga/blob/main/CONTRIBUTING.md).
- [ ] Configured pre-commit and ran colcon test locally.
- [ ] Signed all commits for DCO.
- [ ] Added tests (regression tests for bugs, coverage of new code for features).
Expand Down
30 changes: 30 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,27 @@

Thank you for investing your time in contributing to this project!

## Contributions

Any contribution that you make to this repository will
be under the Apache 2 License, as dictated by that
[license](./LICENSE):

~~~
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
~~~

Contributors must sign-off each commit by adding a `Signed-off-by: ...`
line to commit messages to certify that they have the right to submit
the code they are contributing to the project according to the
[Developer Certificate of Origin (DCO)](https://developercertificate.org/).

## Getting started

### Issues
Expand Down Expand Up @@ -77,3 +98,12 @@ If a related issue doesn't exist, you can [open a new issue](https://github.com/
```

7. Push your changes and [create a PR](https://github.com/ekumenlabs/beluga/compare)!

8. At the time a feature branch is squashed-and-merged into `main`, the commit message should adhere to the following good practices:
- Limit the subject line to 50 characters.
- Capitalize the subject line.
- Do not end the subject line with a period.
- Use the imperative mood in the subject line.
- Wrap the body at 72 characters.
- Use the body to explain _what_ and _why_ vs. _how_.
- See https://cbea.ms/git-commit/ for more information and the reasoning behind this.

0 comments on commit 4cbcda4

Please sign in to comment.