From 6007ae315e4bef2a5ab6d039ceaab1fa8ad45451 Mon Sep 17 00:00:00 2001 From: Joel Labes Date: Tue, 23 Jan 2024 09:17:53 +1300 Subject: [PATCH 1/2] Add licence requirement --- package-best-practices.md | 1 + 1 file changed, 1 insertion(+) diff --git a/package-best-practices.md b/package-best-practices.md index 70dc702..00f41a7 100644 --- a/package-best-practices.md +++ b/package-best-practices.md @@ -13,6 +13,7 @@ To avoid ambiguity, the bullets below are pretty formal, but we are a friendly b The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [RFC 2119](https://datatracker.ietf.org/doc/html/rfc2119). ### First run experience +- Packages MUST include a [licence file detectable by GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository). We strongly encourage an open source licence such as Apache 2.0 or MIT. - Packages SHOULD contain a README file which explains how to get started with the package and customise its behaviour. - The documentation SHOULD indicate which data warehouses are expected to work with this package. From ace11a29b9a099ccb1847d0a7ad095c40c88bc88 Mon Sep 17 00:00:00 2001 From: Joel Labes Date: Tue, 23 Jan 2024 09:19:40 +1300 Subject: [PATCH 2/2] Update PR template to include checkbox for licence --- .github/pull_request_template.md | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 382878c..e185a71 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -8,6 +8,7 @@ Link to your package's repository: _This checklist is a cut down version of the [best practices](../blob/main/package-best-practices.md) that we have identified as the package hub has grown. Although meeting these checklist items is not a prerequisite to being added to the Hub, we have found that packages which don't conform provide a worse user experience._ ### First run experience +- [ ] (Required): The package includes a [licence file detectable by GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository), such as the Apache 2.0 or MIT licence. - [ ] The package includes a README which explains how to get started with the package and customise its behaviour - [ ] The README indicates which data warehouses/platforms are expected to work with this package