diff --git a/.github/workflows/ci-cla-check.yaml b/.github/workflows/ci-cla-check.yaml new file mode 100644 index 00000000..247ce4d8 --- /dev/null +++ b/.github/workflows/ci-cla-check.yaml @@ -0,0 +1,11 @@ +name: cla-check +on: + pull_request: + branches: [ "master" ] + +jobs: + cla-check: + runs-on: ubuntu-latest + steps: + - name: Check if CLA signed + uses: canonical/has-signed-canonical-cla@v2 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..f09f6357 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,32 @@ +# Contributing to secboot + +We are an open source project and welcome community contributions, suggestions, +fixes and constructive feedback. + +If you'd like to contribute, you will first need to sign the Canonical +contributor agreement. This is the easiest way for you to give us permission to +use your contributions. In effect, you’re giving us a licence, but you still +own the copyright — so you retain the right to modify your code and use it in +other projects. + +The agreement can be found, and signed, here: +https://ubuntu.com/legal/contributors + +## Contributor guidelines + +Contributors can help us by observing the following guidelines: + +- Commit messages should be well structured. +- Commit emails should not include non-ASCII characters. +- Several smaller PRs are better than one large PR. +- Try not to mix potentially controversial and trivial changes together. + (Proposing trivial changes separately makes landing them easier and + makes reviewing controversial changes simpler) +- Do not force push a PR after it has received reviews. It is + acceptable to force push when a PR is ready to merge, however. +- Try to write tests to cover the contributed changes (see below) + +## Pull request guidelines + +Contributions are submitted through a pull request created from +a fork of the `secboot` repository (under your GitHub account). diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..87927164 --- /dev/null +++ b/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,2 @@ +Thanks for helping us make a better secboot! +Have you signed the [license agreement](https://www.ubuntu.com/legal/contributors) and read the [contribution guide](CONTRIBUTING.md)?