From 2a20c082a1c0dd581c113d0fc908e7f1797211e5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robert=20Paj=C4=85k?= Date: Wed, 11 Oct 2023 20:48:47 +0200 Subject: [PATCH 1/2] Require CLA Assistant GitHub workflow --- .github/workflows/{cla.yaml => cla.yml} | 0 CHANGELOG.md | 7 +++++++ specification/repository.md | 3 +++ specification/templates/CONTRIBUTING.md | 6 +++--- 4 files changed, 13 insertions(+), 3 deletions(-) rename .github/workflows/{cla.yaml => cla.yml} (100%) diff --git a/.github/workflows/cla.yaml b/.github/workflows/cla.yml similarity index 100% rename from .github/workflows/cla.yaml rename to .github/workflows/cla.yml diff --git a/CHANGELOG.md b/CHANGELOG.md index e0bab85..c847575 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,13 @@ ## [Unreleased] +### Repository + +#### Enhancements + +- Require a CLA Assistant GitHub workflow. (#269) +- Update the CLA notice in `CONTRIBUTING.md` template. (#269) + ## [1.6.0] - 2023-09-14 ### Configuration diff --git a/specification/repository.md b/specification/repository.md index ba7f018..5c4d365 100644 --- a/specification/repository.md +++ b/specification/repository.md @@ -44,6 +44,7 @@ approval is granted, GDI repositories MUST NOT cut a GA release. - MUST have a default branch named `main` - MUST NOT allow anyone (including administrators) pushing directly to `main` - MUST require status checks to pass before merge to `main` + - MUST require a CLA Assistant status check - MUST require at least one CODEOWNER to approve a PR prior to merge - MUST require signed commits on `main` - MUST NOT allow merge commit (squash or rebase merging only) @@ -73,6 +74,8 @@ approval is granted, GDI repositories MUST NOT cut a GA release. to just read access for the `contents` scope. - MUST only set the absolutely required `permissions` (least privilege) - MUST set `permissions` for individual `jobs` +- MUST have a CLA Assistant GitHub workflow integrated with [splunk/cla-agreement](https://github.com/splunk/cla-agreement), + e.g. [cla.yml](../.github/workflows/cla.yml) - SHOULD have Lychee Link Checker GitHub Action configured ### GitHub Applications diff --git a/specification/templates/CONTRIBUTING.md b/specification/templates/CONTRIBUTING.md index cc4ea97..b891d11 100644 --- a/specification/templates/CONTRIBUTING.md +++ b/specification/templates/CONTRIBUTING.md @@ -75,6 +75,9 @@ GitHub provides additional documentation on [forking a repository](https://help.github.com/articles/fork-a-repo/) and [creating a pull request](https://help.github.com/articles/creating-a-pull-request/). +You may be asked to sign our +[Splunk Contributor License Agreement (CLA)](https://github.com/splunk/cla-agreement/blob/main/CLA.md). + ## Finding contributions to work on Looking at the existing issues is a great way to find something to contribute @@ -87,6 +90,3 @@ any 'help wanted' issues is a great place to start. See the [LICENSE](LICENSE) file for our repository's licensing. We will ask you to confirm the licensing of your contribution. -### Contributor License Agreement - -Before contributing, you must sign the [Splunk Contributor License Agreement (CLA)](https://www.splunk.com/en_us/form/contributions.html). From cd3ccc538facc5fc487d65b4fa0a76448b739e9f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robert=20Paj=C4=85k?= Date: Wed, 11 Oct 2023 20:50:06 +0200 Subject: [PATCH 2/2] Remove EOL --- specification/templates/CONTRIBUTING.md | 1 - 1 file changed, 1 deletion(-) diff --git a/specification/templates/CONTRIBUTING.md b/specification/templates/CONTRIBUTING.md index b891d11..8c2194e 100644 --- a/specification/templates/CONTRIBUTING.md +++ b/specification/templates/CONTRIBUTING.md @@ -89,4 +89,3 @@ any 'help wanted' issues is a great place to start. See the [LICENSE](LICENSE) file for our repository's licensing. We will ask you to confirm the licensing of your contribution. -