Want to contribute? Great! First, read this page (including the small print at the end). By submitting a pull request, you represent that you have the right to license your contribution to Zigbee and the community, and agree by submitting the patch that your contributions are licensed under the Apache 2.0 license.
Before submitting the pull request, please make sure you have tested your changes and that they follow the project guidelines for contributing code.
Currently these are the requirements to becoming a member of the Project-CHIP Repository
Currently these are the requirements to becoming a member of the Project-CHIP Repository
This repository contains the source code that implements the CHIP specification. It scalably implements the specification that may be used on a wide range of platforms including Android/iOS and Darwin/Linux down to embedded MCU-based platforms running FreeRTOS and LwIP.
The source code can be built to generate:
If you find a bug in the source code, you can help us by submitting a GitHub Issue. 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 with a fix.
You can request a new feature by submitting a GitHub Issue.
If you would like to implement a new feature, please consider the scope of the new feature:
Large feature: first submit a GitHub Issue and communicate your proposal so that the community can review and provide feedback. Getting early feedback will help ensure your implementation work is accepted by the community. This will also allow us to better coordinate our efforts and minimize duplicated effort.
Small feature: can be implemented and directly submitted as a Pull Request.
CHIP follows the “Fork-and-Pull” model for accepting contributions.
Setup your GitHub fork and continuous-integration services:
Fork the CHIP repository by clicking “Fork” on the web UI.
All contributions must pass all checks and reviews to be accepted.
Setup your local development environment:
# Clone your fork git clone git@github.com:<username>/connectedhomeip.git # Configure upstream alias git remote add upstream git@github.com:project-chip/connectedhomeip.git
For each new feature, create a working branch:
# Create a working branch for your new feature git branch --track <branch-name> origin/master # Checkout the branch git checkout <branch-name>
# Add each modified file you'd like to include in the commit git add <file1> <file2> # Create a commit git commit
This will open up a text editor where you can craft your commit message.
Prior to submitting your pull request, you might want to do a few things to clean up your branch and make it as simple as possible for the original repository's maintainer to test, accept, and merge your work.
If any commits have been made to the upstream master branch, you should rebase your development branch so that merging it will be a simple fast-forward that won't require any conflict resolution work.
# Fetch upstream master and merge with your repository's master branch git checkout master git pull upstream master # If there were any new commits, rebase your development branch git checkout <branch-name> git rebase master
Now, it may be desirable to squash some of your smaller commits down into a small number of larger more cohesive commits. You can do this with an interactive rebase:
# Rebase all commits on your development branch git checkout git rebase -i master
This will open up a text editor where you can specify which commits to squash.
# Checkout your branch git checkout <branch-name> # Push to your GitHub fork: git push origin <branch-name>
This will trigger the continuous-integration checks. You can view the results in the respective services. Note that the integration checks will report failures on occasion.
CHIP considers there to be a few different types of pull requests:
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 | 3 approved reviewers | ||||
| Small Bug fix | 3 approved reviewers | ||||
| Bug Fix | 3 approved reviewers | ||||
| Significiant Change | 3 approved reviewers | ||||
| Feature | 3 approved reviewers | ||||
| Architecture Change | 3 approved reviewers |
Note: Where multiple reviewers are required, each reviewer must be from a different member company.
Once you've validated the CI results, go to the page for your fork on GitHub, select your development branch, and click the pull request 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.
When can I merge? After these have been satisfied, any reviewer, or the originator can merge the PR into master.
Documentation undergoes the same review process as code
See the Documentation Style Guide for more information on how to author and format documentation for contribution.