-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added contributing guide and code of conduct
- Loading branch information
1 parent
0068f85
commit 920b6c2
Showing
3 changed files
with
163 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,132 @@ | ||
|
|
||
| # Contributor Covenant Code of Conduct | ||
|
|
||
| ## Our Pledge | ||
|
|
||
| We as members, contributors, and leaders pledge to make participation in our | ||
| community a harassment-free experience for everyone, regardless of age, body | ||
| size, visible or invisible disability, ethnicity, sex characteristics, gender | ||
| identity and expression, level of experience, education, socio-economic status, | ||
| nationality, personal appearance, race, caste, color, religion, or sexual | ||
| identity and orientation. | ||
|
|
||
| We pledge to act and interact in ways that contribute to an open, welcoming, | ||
| diverse, inclusive, and healthy community. | ||
|
|
||
| ## Our Standards | ||
|
|
||
| Examples of behavior that contributes to a positive environment for our | ||
| community include: | ||
|
|
||
| * Demonstrating empathy and kindness toward other people | ||
| * Being respectful of differing opinions, viewpoints, and experiences | ||
| * Giving and gracefully accepting constructive feedback | ||
| * Accepting responsibility and apologizing to those affected by our mistakes, | ||
| and learning from the experience | ||
| * Focusing on what is best not just for us as individuals, but for the overall | ||
| community | ||
|
|
||
| Examples of unacceptable behavior include: | ||
|
|
||
| * The use of sexualized language or imagery, and sexual attention or advances of | ||
| any kind | ||
| * Trolling, insulting or derogatory comments, and personal or political attacks | ||
| * Public or private harassment | ||
| * Publishing others' private information, such as a physical or email address, | ||
| without their explicit permission | ||
| * Other conduct which could reasonably be considered inappropriate in a | ||
| professional setting | ||
|
|
||
| ## Enforcement Responsibilities | ||
|
|
||
| Community leaders are responsible for clarifying and enforcing our standards of | ||
| acceptable behavior and will take appropriate and fair corrective action in | ||
| response to any behavior that they deem inappropriate, threatening, offensive, | ||
| or harmful. | ||
|
|
||
| Community leaders 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, and will communicate reasons for moderation | ||
| decisions when appropriate. | ||
|
|
||
| ## Scope | ||
|
|
||
| This Code of Conduct applies within all community spaces, and also applies when | ||
| an individual is officially representing the community in public spaces. | ||
| Examples of representing our community include using an official email address, | ||
| posting via an official social media account, or acting as an appointed | ||
| representative at an online or offline event. | ||
|
|
||
| ## Enforcement | ||
|
|
||
| Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
| [reported to the community leaders responsible for enforcement](mailto:alexander.daniel@nottingham.ac.uk?subject=3DQLayers_Conduct). | ||
| All complaints will be reviewed and investigated promptly and fairly. | ||
|
|
||
| All community leaders are obligated to respect the privacy and security of the | ||
| reporter of any incident. | ||
|
|
||
| ## Enforcement Guidelines | ||
|
|
||
| Community leaders will follow these Community Impact Guidelines in determining | ||
| the consequences for any action they deem in violation of this Code of Conduct: | ||
|
|
||
| ### 1. Correction | ||
|
|
||
| **Community Impact**: Use of inappropriate language or other behavior deemed | ||
| unprofessional or unwelcome in the community. | ||
|
|
||
| **Consequence**: A private, written warning from community leaders, providing | ||
| clarity around the nature of the violation and an explanation of why the | ||
| behavior was inappropriate. A public apology may be requested. | ||
|
|
||
| ### 2. Warning | ||
|
|
||
| **Community Impact**: A violation through a single incident or series of | ||
| actions. | ||
|
|
||
| **Consequence**: A warning with consequences for continued behavior. No | ||
| interaction with the people involved, including unsolicited interaction with | ||
| those enforcing the Code of Conduct, for a specified period of time. This | ||
| includes avoiding interactions in community spaces as well as external channels | ||
| like social media. Violating these terms may lead to a temporary or permanent | ||
| ban. | ||
|
|
||
| ### 3. Temporary Ban | ||
|
|
||
| **Community Impact**: A serious violation of community standards, including | ||
| sustained inappropriate behavior. | ||
|
|
||
| **Consequence**: A temporary ban from any sort of interaction or public | ||
| communication with the community for a specified period of time. No public or | ||
| private interaction with the people involved, including unsolicited interaction | ||
| with those enforcing the Code of Conduct, is allowed during this period. | ||
| Violating these terms may lead to a permanent ban. | ||
|
|
||
| ### 4. Permanent Ban | ||
|
|
||
| **Community Impact**: Demonstrating a pattern of violation of community | ||
| standards, including sustained inappropriate behavior, harassment of an | ||
| individual, or aggression toward or disparagement of classes of individuals. | ||
|
|
||
| **Consequence**: A permanent ban from any sort of public interaction within the | ||
| community. | ||
|
|
||
| ## Attribution | ||
|
|
||
| This Code of Conduct is adapted from the [Contributor Covenant][homepage], | ||
| version 2.1, available at | ||
| [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. | ||
|
|
||
| Community Impact Guidelines were inspired by | ||
| [Mozilla's code of conduct enforcement ladder][Mozilla CoC]. | ||
|
|
||
| For answers to common questions about this code of conduct, see the FAQ at | ||
| [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at | ||
| [https://www.contributor-covenant.org/translations][translations]. | ||
|
|
||
| [homepage]: https://www.contributor-covenant.org | ||
| [v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html | ||
| [Mozilla CoC]: https://github.com/mozilla/diversity | ||
| [FAQ]: https://www.contributor-covenant.org/faq | ||
| [translations]: https://www.contributor-covenant.org/translations |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| # Contributing to QLayers | ||
|
|
||
| Thank you for considering contributing to QLayers! We welcome contributions from everyone. There are many ways to contribute, from writing tutorials or examples, improvements to the documentation, bug reports and feature requests, to contributing code that can be incorporated into QLayers itself. This contributing guide should give you an idea of how you can help make QLayers better. In general, we're just happy people are interested in this software and any feedback is greatly appreciated. | ||
|
|
||
| ## Questions | ||
| If you have a question, your first port of call should be the [documentation](https://qlayers.readthedocs.io/latest/). If you can't find an answer there then you can submit an issue on the [GitHub issue tracker](https://github.com/alexdaniel654/qlayers/issues) or if you'd rather ask a question in private you can [email me](mailto:alexander.daniel@nottingham.ac.uk?subject=3DQLayers). | ||
|
|
||
| ## Contributions | ||
|
|
||
| ### Tiny Changes | ||
| If you spot things like typos, please submit an issue or a pull request. We're always happy to receive these. | ||
|
|
||
| ### Reporting Bugs | ||
| If you find a bug in QLayers, please submit an issue to the [GitHub issue tracker](https://github.com/alexdaniel654/qlayers/issues). When submitting an issue, please include a title and clear description of the issue. If possible, include a code snippet that demonstrates the issue, as well as any error messages you receive. If you can, please include the version of QLayers you are using, as well as the version of Python and any other relevant packages. | ||
|
|
||
| ### Suggesting Enhancements | ||
| If you have an idea for enhancement to an existing feature, please submit an issue. Chances are we'll ask you to submit a pull request with your enhancement. When you submit an enhancement, please make sure its fully tested and documented, including adding tests to the test suite. | ||
|
|
||
| ### New Features | ||
| QLayers currently just focuses on the kidneys. There's a balance between keeping the code general enough that, with a bit of tweaking, it can be used for other organs and keeping it easy to use for the kidneys. For this reason we suggest you submit an issue before starting work on a new feature. This way we can discuss the best way to implement the feature and make sure it fits with the rest of the codebase. If we agree your new feature fits well with QLayers then we'll ask you to submit a pull request. As with enhancements, please make sure your new feature is fully tested and documented. | ||
|
|
||
| ### Suggested Documentation Changes | ||
| If you find the documentation lacking, please submit an issue and we can try and improve it. Especially welcome are tutorials and examples that show how to use QLayers in different ways. | ||
|
|
||
| ## Styleguide | ||
| QLayers is written according to [pep8](https://peps.python.org/pep-0008/). The easiest way to make sure your code conforms to this style is to use [Black](https://black.readthedocs.io/en/stable/). Black is a code formatter that will automatically format your code to conform to pep8. It can easily be installed via pip and many IDEs can automatically run black on your code when you save a file. | ||
|
|
||
| ## Code of Conduct | ||
| Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters