Skip to content

Latest commit

 

History

History
61 lines (46 loc) · 2.43 KB

CONTRIBUTING.md

File metadata and controls

61 lines (46 loc) · 2.43 KB

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue or any other method with the owners of this repository before making a change.

Please note we have a code of conduct, please follow it in all your interactions with the project.

Dependencies

To contribute, you will need to locally compile the package. Make sure you have CMake (≥ 3.28), a c++ compiler, and the eigen3 library installed. Then, you can either install the package on your system:

pip install . -v

or compile it in-place for development:

./local_compile.sh

Pull Request Process

Create a pull request from your forked repository to the main branch of the original repository. The pull request will be reviewed and discussed.

  1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
  3. Increase the version numbers in any relevant files to the new version that this Pull Request would represent.
  4. Only maintainers can merge pull requests.

Code of Conduct

Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

Our Standards

Examples of behavior that contributes to creating a positive environment include:

  • Using welcoming and inclusive language
  • Being respectful of differing viewpoints and experiences
  • Gracefully accepting constructive criticism
  • Focusing on what is best for the community
  • Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

  • The use of sexualized language or imagery and unwelcome sexual attention or advances
  • Trolling, insulting/derogatory comments, and personal or political attacks
  • Public or private harassment
  • Publishing others' private information, such as a physical or electronic address, without explicit permission
  • Other conduct which could reasonably be considered inappropriate in a professional setting