All contributed code should be PEP8 compliant, using maximum line lengths between 100-120 characters. The main (formerly: master) branch should only be updated with stable releases including full testing and documentation, and approval by the full dev team. All additions should be developed in a dedicated feature or bug branch, and then merged into the dev branch including basic documentation. All merges require review/approval by a member of the dev team, and PR authors cannot merge their own PRs.
All API functionality should use cgs (centimeter, gram, second) units: both input (arguments) and output (return values). In both function and class docstrings, include the git username of the original author, and the names of contributors who make substantial changes or additions. Dependencies (external packages) should be minimized, within reason, and must be installable with a single pip/conda command. External packages must also be open, tested, documented, and actively maintained.
All contributors are expected to abide by the Code of Conduct below.
- Open an issue for discussion and record-keeping
- Fork the repo
- Check out a new feature or bug branch
- Add your changes, and add/update tests
- Update the CHANGELOG for any API changes
- Submit a pull request to the dev branch of the upstream repo
- Add description of your changes
- Ensure tests are passing
- Ensure branch is mergeable
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.
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 that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
Moreover, project maintainers will strive to offer feedback and advice to ensure quality and consistency of contributions to the code. Contributions from outside the group of project maintainers are strongly welcomed but the final decision as to whether commits are merged into the codebase rests with the team of project maintainers.
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 team at '[email protected]'. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
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
(List is very likely out-of-date, please bump if you notice someone/yourself missing!)
Bence Becsy
Andrew Casey-Clyde
Alex Cingoranelli
Siyuan Chen
Daniel D’Orazio
Emiko Gardiner
Kayhan Gültekin
William Lamb
Luke Zoltan Kelley
Cayenne Matt
Joseph Simon
Magdalena Siwek
Jeremy Wachter
David Wright