From 2eb74878fa62eebceade9b5dfa1e1596a418d6fd Mon Sep 17 00:00:00 2001 From: Justin Wood Date: Tue, 3 Mar 2020 15:36:27 -0800 Subject: [PATCH 1/5] Initial Skeleton --- CONTRIBUTING.md | 15 ++++++++++++++- README.md | 4 ++-- docs/CONTRIBUTION_GUIDELINES.md | 1 + 3 files changed, 17 insertions(+), 3 deletions(-) create mode 100644 docs/CONTRIBUTION_GUIDELINES.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 438e4f56c3cf56..c104d7932292bb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,9 +8,22 @@ community, and agree by submitting the patch that your contributions are license [Apache 2.0 license](./LICENSE.md). Before submitting the pull request, please make sure you have tested your changes and that they follow the project -[guidelines for contributing code](./docs/contribution_guidelines.md). +[guidelines for contributing code](./docs/CONTRIBUTION_GUIDELINES.md). +## Becoming a Member + +Currently these are the requirements to becoming a member of the [Project-CHIP Repository](https://github.com/project-chip/connectedhomeip/connectedhomeip.git) +* Must be a member of the Zigbee Alliance CHIP TSG Working Group +* Have signed the Zigbee CHIP WG CLA + +## Becoming a Contributor + +Currently these are the requirements to becoming a member of the [Project-CHIP Repository](https://github.com/project-chip/connectedhomeip/connectedhomeip.git) +* Must be a member of the Zigbee Alliance CHIP TSG Working Group +* Have signed the Zigbee CHIP WG CLA +* Agree to the code of conduct + ## Bugs If you find a bug in the source code, you can help us by [submitting a GitHub Issue](https://github.com/project-chip/connectedhomeip/issues/new). The best bug reports provide a detailed description of the issue and step-by-step instructions for predictably reproducing the issue. Even better, you can [submit a Pull Request](#submitting-a-pull-request) with a fix. diff --git a/README.md b/README.md index 4ee810a3263a5a..78c4935beb3153 100644 --- a/README.md +++ b/README.md @@ -12,8 +12,8 @@ Additional build information can also be found in [BUILDING.md](./BUILDING.md). # Need help? There are numerous avenues for CHIP support: -* Bugs and feature requests — [submit to the Issue Tracker](https://github.com/project-chip/connectedhomeip/issues) -* Stack Overflow — [post questions using the chip tag](http://stackoverflow.com/questions/tagged/chip) +* Bugs and feature requests [submit to the Issue Tracker](https://github.com/project-chip/connectedhomeip/issues) +* Stack Overflow [post questions using the chip tag](http://stackoverflow.com/questions/tagged/chip) # Directory Structure diff --git a/docs/CONTRIBUTION_GUIDELINES.md b/docs/CONTRIBUTION_GUIDELINES.md new file mode 100644 index 00000000000000..8a1b9f12e280c0 --- /dev/null +++ b/docs/CONTRIBUTION_GUIDELINES.md @@ -0,0 +1 @@ +# Contribution Guidelines From c2b61d915b17dd74a56354d03b688f4a910575bb Mon Sep 17 00:00:00 2001 From: Justin Wood Date: Tue, 3 Mar 2020 15:44:59 -0800 Subject: [PATCH 2/5] Adding links to the code of conduct/license --- CONTRIBUTING.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c104d7932292bb..5a763c9f3411a0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -22,7 +22,9 @@ Currently these are the requirements to becoming a member of the [Project-CHIP R Currently these are the requirements to becoming a member of the [Project-CHIP Repository](https://github.com/project-chip/connectedhomeip/connectedhomeip.git) * Must be a member of the Zigbee Alliance CHIP TSG Working Group * Have signed the Zigbee CHIP WG CLA -* Agree to the code of conduct +* Agree to the [Code of Conduct](./CODE_OF_CONDUCT.md) +* Agree to the [License](./LICENSE) + ## Bugs From 95174b43ec0360db9d408246417d7ba42a967138 Mon Sep 17 00:00:00 2001 From: Justin Wood Date: Tue, 3 Mar 2020 15:58:18 -0800 Subject: [PATCH 3/5] Adding merge requirements --- CONTRIBUTING.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5a763c9f3411a0..7431064aa61b71 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -196,7 +196,20 @@ your development branch and update. #### Code reviews -All submissions, including submissions by project members, require review. +All submissions, including submissions by project members, require 3 reviews to be accepted from different member companies. + +#### Merge Requirements + +* At least 3 review approvals each from different member companies +* [GitHub Workflows](../.github/workflows) pass +* [Certification Tests](tests/certification/README.md) pass +* [Unit Tests](tests/unit/README.md) pass +* [Fuzz Tests](tests/fuzz/README.md) pass +* [Integration Tests](tests/integration/README.md) pass +* Linting passes +* Code style passes + +**When can I merge?** After these have been satisfied, any reviewer, or the originator can merge the PR into master. ### Documentation From 7b11651826ee2f01fabae0235eb6544d888c5894 Mon Sep 17 00:00:00 2001 From: Justin Wood Date: Tue, 3 Mar 2020 16:13:59 -0800 Subject: [PATCH 4/5] Adding reviewers and review guidelines --- CONTRIBUTING.md | 22 ++++++++++------------ REVIEWERS.md | 9 +++++++++ 2 files changed, 19 insertions(+), 12 deletions(-) create mode 100644 REVIEWERS.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7431064aa61b71..904f55be4b168e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -174,17 +174,19 @@ CHIP considers there to be a few different types of pull requests: - Linting passes - Code style passes +### Review Requirements Each type of change has unique additional requirements, here's a table of those: + | Type | Reviewer Requirements | New Unit Tests | New Certification Tests | New Fuzz Tests | New Integration Tests | |----|----|----|----|----|----| -| Trivial bug fix | | | | | | -| Small Bug fix | | | | | | | -| Bug Fix | | | | | | | -| Significiant Change | | | | | | | -| Feature | | | | | | | -| Architecture Change | | | | | | | - +| Trivial bug fix | 3 [approved reviewers](./REVIEWERS.md) | | | | | +| Small Bug fix | 3 [approved reviewers](./REVIEWERS.md) | | | | | +| Bug Fix | 3 [approved reviewers](./REVIEWERS.md) | | | | | +| Significiant Change | 3 [approved reviewers](./REVIEWERS.md) | | | | | +| Feature | 3 [approved reviewers](./REVIEWERS.md) | | | | | +| Architecture Change | 3 [approved reviewers](./REVIEWERS.md) | | | | | +Note: Where multiple reviewers are required, each reviewer must be from a different member company. #### Submit Pull Request @@ -194,13 +196,9 @@ button. If you need to make any adjustments to your pull request, just push the updates to GitHub. Your pull request will automatically track the changes on your development branch and update. -#### Code reviews - -All submissions, including submissions by project members, require 3 reviews to be accepted from different member companies. - #### Merge Requirements -* At least 3 review approvals each from different member companies +* Passes [Review Requirements](#review-requirements) * [GitHub Workflows](../.github/workflows) pass * [Certification Tests](tests/certification/README.md) pass * [Unit Tests](tests/unit/README.md) pass diff --git a/REVIEWERS.md b/REVIEWERS.md new file mode 100644 index 00000000000000..71ea6d902230e8 --- /dev/null +++ b/REVIEWERS.md @@ -0,0 +1,9 @@ +The following individuals can be chosen as, and act as reviewers on any PR + +| Name | Company | +|----|----| +| [anush-apple](https://github.com/anush-apple) | Apple, Inc. | +| [chrisdecenzo](https://github.com/chrisdecenzo) | Google, Inc. | +| [hawk248](https://github.com/hawk248) | Comcast, Inc. | +| [gerickson](https://github.com/gerickson) | Google, Inc. | +| [robszewczyk](https://github.com/robszewczyk) | Google, Inc. | From ab0c0e417f5d08cfb40307e8a1759b48a2c14b3c Mon Sep 17 00:00:00 2001 From: Justin Wood Date: Tue, 3 Mar 2020 16:50:28 -0800 Subject: [PATCH 5/5] Per approval. + myself as a reviewer for Apple --- REVIEWERS.md | 1 + 1 file changed, 1 insertion(+) diff --git a/REVIEWERS.md b/REVIEWERS.md index 71ea6d902230e8..15925fe9fdc855 100644 --- a/REVIEWERS.md +++ b/REVIEWERS.md @@ -7,3 +7,4 @@ The following individuals can be chosen as, and act as reviewers on any PR | [hawk248](https://github.com/hawk248) | Comcast, Inc. | | [gerickson](https://github.com/gerickson) | Google, Inc. | | [robszewczyk](https://github.com/robszewczyk) | Google, Inc. | +| [woody-apple](https://github.com/woody-apple) | Apple, Inc. |