diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 438e4f56c3cf56..904f55be4b168e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,7 +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](./CODE_OF_CONDUCT.md) +* Agree to the [License](./LICENSE) ## Bugs @@ -159,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 @@ -179,9 +196,18 @@ 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 +#### Merge Requirements + +* Passes [Review Requirements](#review-requirements) +* [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 -All submissions, including submissions by project members, require review. +**When can I merge?** After these have been satisfied, any reviewer, or the originator can merge the PR into master. ### Documentation 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/REVIEWERS.md b/REVIEWERS.md new file mode 100644 index 00000000000000..15925fe9fdc855 --- /dev/null +++ b/REVIEWERS.md @@ -0,0 +1,10 @@ +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. | +| [woody-apple](https://github.com/woody-apple) | Apple, Inc. | 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