diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 4fd592a0c..f530e4f97 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,6 +1,6 @@ --- name: Bug Report -about: Report a bug in beluga +about: Report a bug in beluga. title: '' labels: bug diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 56bf55b59..c9668f458 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,6 +1,6 @@ --- name: Feature Request -about: Request a new feature for beluga +about: Request a new feature for beluga. title: '' labels: enhancement diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 272026a5d..3d1140846 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -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). diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e20237d4c..60823d2ed 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 @@ -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.