diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 506d4cca8..0f6d4a5b6 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -11,8 +11,8 @@ --> ## Checklist +If this is your first time contributing please [sign the CLA](https://docs.bearer.com/contributing/) - [ ] I've added test coverage that shows my fix or feature works as expected. - [ ] I've updated or added documentation if required. -- [ ] I've included usage information in the description if CLI behavior was updated or added. -- [ ] PR title follows [Conventional Commits](https://www.conventionalcommits.org/) format + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 467804dda..310685c61 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,3 +5,9 @@ Thanks for your interest in contributing to Bearer. You can find guides and everything you need to started in the [Contributing to Bearer](https://docs.bearer.com/contributing/) documentation. When in doubt, don't hesitate to [raise an issue]({{meta.links.issues}}) or jump into the [community discord]({{meta.links.discord}}). + +## CLA (Contributor License Agreement) + +A Contributor License Agreement (CLA) is a legal document that outlines the terms and conditions under which a contributor submits their work, such as code, documentation, or other materials, to a project. + +Before submitting any Pull Request, please take a look at our [CLA document](https://docs.bearer.com/cla.pdf), fill it out and send it to [research@cycode.com](mailto:research@cycode.com). After that, you are good to go.. \ No newline at end of file diff --git a/docs/.eleventy.js b/docs/.eleventy.js index 9f9e6da9a..5b0f5c073 100644 --- a/docs/.eleventy.js +++ b/docs/.eleventy.js @@ -46,6 +46,7 @@ module.exports = function (eleventyConfig) { eleventyConfig.addPassthroughCopy({ "./_tmp/style.css": "./style.css" }) eleventyConfig.addPassthroughCopy({ "./robots.txt": "./robots.txt" }) eleventyConfig.addPassthroughCopy({ "./_redirects": "./_redirects" }) + eleventyConfig.addPassthroughCopy({ "./assets/cla.pdf": "./cla.pdf" }) eleventyConfig.addDataExtension("yaml", (contents) => yaml.load(contents)) eleventyConfig.addShortcode("version", function () { return now diff --git a/docs/assets/cla.pdf b/docs/assets/cla.pdf new file mode 100644 index 000000000..a90916752 Binary files /dev/null and b/docs/assets/cla.pdf differ diff --git a/docs/contributing/index.md b/docs/contributing/index.md index 283f3a2b8..1843bfdf9 100644 --- a/docs/contributing/index.md +++ b/docs/contributing/index.md @@ -18,6 +18,12 @@ You can contribute in a variety of ways: All contributions and interactions with the community must adhere to our [contributor code of conduct]({{meta.sourcePath}}/blob/main/CODE_OF_CONDUCT.md). +### CLA (Contributor License Agreement) + +A Contributor License Agreement (CLA) is a legal document that outlines the terms and conditions under which a contributor submits their work, such as code, documentation, or other materials, to a project. + +Before submitting any Pull Request, please take a look at our [CLA document](/cla.pdf), fill it out and send it to [research@cycode.com](mailto:research@cycode.com). After that, you are good to go. + ## Best practices Here are some tips to get you started: