When contributing to this repository, please first discuss the change you wish to make via creation of a github issue. Thereafter, contributors should create a new 'feature' branch (branched off of the 'dev' branch) for any changes/additions they wish to make, and then create a pull request for merging this feature branch into 'dev'. If making a change to a submodule, a pull request should be sent to that submodule's repository. (e.g. if a user is making a change to a file within the signals repository, a pull request should be made to the signals repository, not to the Rigbox repository.) TLDR: All feature branches should be branched off of 'dev', and pull requests should be made to 'dev'. If making a change to a submodule, send the pull request to the 'dev' branch of that submodule's repository.
All pull requests will be reviewed by the project maintainers. Detailed information on the guidelines the project maintainers follow when developing code and reviewing pull requests can be found here.
Rigbox is currently maintained and developed by Miles Wells ([email protected]), Jai Bhagat ([email protected]), and a number of others at CortexLab. Much of the code was written by Chris Burgess.
In the interest of fostering an open and welcoming environment, we as maintainers and contributors pledge to make participation in our project and our community an enjoyable and harassment-free experience for everyone.
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
Project maintainers are responsible for clarifying the standards of acceptable behavior, and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions, particularly those that are not aligned to this Code of Conduct.
Project maintainers may ban temporarily or permanently any contributor for behaviors that are deemed inappropriate, threatening, offensive, or harmful.
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project maintainers. All complaints will be reviewed and investigated, and will result in a response that is deemed necessary and appropriate to the circumstances.
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at http://contributor-covenant.org/version/1/4.