Skip to content

Latest commit

 

History

History
195 lines (143 loc) · 6.89 KB

CONTRIBUTING.md

File metadata and controls

195 lines (143 loc) · 6.89 KB
Raw

Contributing to Project Connected Home over IP

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 the Zigbee Alliance 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.

Contributing as an Open Source Contributor

As an open source contributor you can report bugs and request features in the Issue Tracker, as well as contribute bug fixes and features that do not impact the Project CHIP specification as a pull request. For example: ports of Project CHIP to add APIs to alternative programming languages (e.g. Java, JS), hardware ports, or an optimized implementation of existing functionality. For features that impact the specification, please join Project CHIP work group within the Zigbee Alliance. The requirements to become an open source contributor of the Project CHIP Repository are:

Contributing as a Zigbee Alliance Project CHIP Working Group Member

As a participant of the Zigbee Alliance Project CHIP working group, you can attend working group meetings, propose changes to the Project CHIP specification, and contribute code for approved updates to the specification. The requirements to become a member of the Project CHIP Repository are:

  • Must be a Participant member or higher of the Zigbee Alliance
  • Must be a Project CHIP Working Group member
  • Have signed the Zigbee Project CHIP Work Group CLA
  • Have approval from your company's official approver

Bugs

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.

New Features

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.

Contributing Code

Project CHIP follows the "Fork-and-Pull" model for accepting contributions.

Initial Setup

Setup your GitHub fork and continuous-integration services:

  1. Fork the Project CHIP repository by clicking "Fork" on the web UI.

  2. All contributions must pass all checks and reviews to be accepted.

Setup your local development environment:

# Clone your fork
git clone [email protected]:<username>/connectedhomeip.git

# Configure upstream alias
git remote add upstream [email protected]:project-chip/connectedhomeip.git

Submitting a Pull Request

Branch

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>

Create Commits

# 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.

Upstream Sync and Clean Up

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.

Push and Test

# 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.

Review Requirements

Documentation Best Practices

Project CHIP uses Doxygen to markup (or markdown) all C, C++, Objective C, Objective C++, Perl, Python, and Java code. Read our Doxygen Best Practices, Conventions, and Style

Submit Pull Request

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.

Merge Requirements

  • Github Workflows pass
  • Builds pass
  • Tests pass
  • Linting passes
  • Code style passes

When can I merge? After these have been satisfied, a reviewer will merge the PR into master

Documentation

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.