Skip to content

Commit

Permalink
Merge pull request project-chip#4 from woody-apple/contribution
Browse files Browse the repository at this point in the history
Membership & Contribution Policies
  • Loading branch information
woody-apple authored Mar 4, 2020
2 parents c0e87a3 + ab0c0e4 commit 0692fac
Show file tree
Hide file tree
Showing 4 changed files with 49 additions and 12 deletions.
46 changes: 36 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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

Expand All @@ -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

Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
10 changes: 10 additions & 0 deletions REVIEWERS.md
Original file line number Diff line number Diff line change
@@ -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. |
1 change: 1 addition & 0 deletions docs/CONTRIBUTION_GUIDELINES.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Contribution Guidelines

0 comments on commit 0692fac

Please sign in to comment.