Skip to content

Latest commit

 

History

History
72 lines (57 loc) · 5.18 KB

CONTRIBUTING.md

File metadata and controls

72 lines (57 loc) · 5.18 KB
Raw

How to Contribute

This project welcomes third-party code via GitHub pull requests.

You are welcome to propose and discuss enhancements using project issues.

Branching Policy: The master branch is considered stable, at all times. The development branch is the one where all contributions must be merged before being promoted to master. If you plan to propose a patch, please commit into the development branch, or its own feature branch.

We recommend enabling Github Actions on your fork of librealsense to make sure the changes compile on all platforms and pass unit-tests.

In addition, please run pr_check.sh and api_check.sh under scripts directory. These scripts verify compliance with project's standards:

  1. Every example / source file must refer to LICENSE
  2. Every example / source file must include correct copyright notice
  3. For indentation we are using spaces and not tabs
  4. Line-endings must be Unix and not DOS style
  5. Every API header file must be able to compile as the first included header (no implicit dependencies)

Most common issues can be automatically resolved by running ./pr_check.sh --fix

Please familirize yourself with the Apache License 2.0 before contributing.

Step-by-Step

  1. Make sure you have git and cmake installed on your system. On Windows we recommend using Git Extensions for git bash.
  2. Run git clone https://github.com/IntelRealSense/librealsense.git and cd librealsense
  3. To align with latest status of the development branch, run:
git fetch origin
git checkout development
git reset --hard origin/development
  1. git checkout -b name_of_your_contribution to create a dedicated branch
  2. Make your changes to the local repository
  3. Make sure your local git user is updated, or run git config --global user.email "[email protected]" and git config --global user.user "user" to set it up. This is the user & email that will appear in GitHub history.
  4. git add -p to select the changes you wish to add
  5. git commit -m "Description of the change"
  6. Make sure you have a GitHub user and fork librealsense
  7. git remote add fork https://github.com/username/librealsense.git with your GitHub username
  8. git fetch fork
  9. git push fork to push name_of_your_contribution branch to your fork
  10. Go to your fork on GitHub at https://github.com/username/librealsense
  11. Click the New pull request button
  12. For base combo-box select development, since you want to submit a PR to that branch
  13. For compare combo-box select name_of_your_contribution with your commit
  14. Review your changes and click Create pull request
  15. Wait for all automated checks to pass
  16. The PR will be approved / rejected after review from the team and the community

To continue to new change, goto step 3. To return to your PR (in order to make more changes):

  1. git stash
  2. git checkout name_of_your_contribution
  3. Repeat items 5-8 from the previous list
  4. git push fork The pull request will be automatically updated

Comment about the Wrappers

It is very time consuming (and often impossible) for a single developer to test contributed functionality using all of the supported wrappers. There is no expectation of adding new functionality to all of the wrappers. One noteable exception is maintaining parity of public enumerations. Without strict maintanance it is easy for these lists to go out of sync and this can have serious runtime consequences.

For example, when adding new value to rs2_option enum, please also add it to:

  1. The list of Matlab options under wrappers/matlab/option.m
  2. The list of options for Unreal Engine integration
  3. The list of options in the C# wrapper - wrappers/csharp/Intel.RealSense/Types/Enums/Option.cs
  4. The list of Java options used for Android integration - wrappers/android/librealsense/src/main/java/com/intel/realsense/librealsense/Option.java
  5. The list of options in the python wrapper

Once all are updated Github Actions will give clear indication that each of the wrappers is still passing compilation.