Contributing#
Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given. You can contribute in the ways listed below.
Report Bugs#
Report bugs using GitHub issues.
If you are reporting a bug, please include:
Your operating system name and version.
Any details about your local setup that might be helpful in troubleshooting.
Detailed steps to reproduce the bug.
Fix Bugs#
Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.
Copyedits#
If you see any grammatical errors or sections that do not make sense, please send comments through issues or contact me directly.
Submit Feedback#
The best way to send feedback is to file an issue on GitHub.
If you propose a change, addition, or suggestion, remember that this is a volunteer-driven project and that contributions are welcome.
Get Started#
Ready to contribute? Here’s how to set the foss book for local contributions:
Fork the repo on GitHub.
Clone your fork locally.
Install your local copy into a virtualenv, e.g., using
conda.Create a branch for local development and make changes locally.
Commit your changes and push your branch to GitHub.
Submit a pull request through the GitHub website.
Code of Conduct#
As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
Project maintainers are responsible for removing, editing, or rejecting comments, commits, code, wiki edits, issues, and other contributions not aligned with this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more project maintainers.
This Code of Conduct is adapted from the Contributor Covenant, version 1.0.0, available here.