-
Notifications
You must be signed in to change notification settings - Fork 21
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
225 additions
and
109 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 |
|---|---|---|
| @@ -1,24 +1,77 @@ | ||
| # IM Code of Conduct | ||
|
|
||
| This isn’t an exhaustive list of things that you can’t do. Rather, take it in the spirit in which it’s intended - a guide to make it easier to enrich all of us and the technical communities in which we participate. | ||
|
|
||
| This code of conduct applies to all spaces managed by the IM project. In addition, violations of this code outside these spaces may affect a person's ability to participate within them. | ||
|
|
||
| If you believe someone is violating the code of conduct, we ask that you report it by emailing [email protected]. | ||
|
|
||
| * Be friendly and patient. | ||
| * Be welcoming. We strive to be a community that welcomes and supports people of all backgrounds and identities. This includes, but is not limited to members of any race, ethnicity, culture, national origin, colour, immigration status, social and economic class, educational level, sex, sexual orientation, gender identity and expression, age, size, family status, political belief, religion, and mental and physical ability. | ||
| * Be considerate. Your work will be used by other people, and you in turn will depend on the work of others. Any decision you take will affect users and colleagues, and you should take those consequences into account when making decisions. Remember that we're a world-wide community, so you might not be communicating in someone else's primary language. | ||
| * Be respectful. Not all of us will agree all the time, but disagreement is no excuse for poor behavior and poor manners. We might all experience some frustration now and then, but we cannot allow that frustration to turn into a personal attack. It’s important to remember that a community where people feel uncomfortable or threatened is not a productive one. | ||
| * Be careful in the words that you choose. We are a community of professionals, and we conduct ourselves professionally. Be kind to others. Do not insult or put down other participants. Harassment and other exclusionary behavior aren't acceptable. This includes, but is not limited to: | ||
| * Violent threats or language directed against another person. | ||
| * Discriminatory jokes and language. | ||
| * Posting sexually explicit or violent material. | ||
| * Posting (or threatening to post) other people's personally identifying information ("doxing"). | ||
| * Personal insults, especially those using racist or sexist terms. | ||
| * Unwelcome sexual attention. | ||
| * Advocating for, or encouraging, any of the above behavior. | ||
| * Repeated harassment of others. In general, if someone asks you to stop, then stop. | ||
| * When we disagree, try to understand why. Disagreements, both social and technical, happen all the time. It is important that we resolve disagreements and differing views constructively. Remember that we’re different. Being unable to understand why someone holds a viewpoint doesn’t mean that they’re wrong. Don’t forget that it is human to err and blaming each other doesn’t get us anywhere. Instead, focus on helping to resolve issues and learning from mistakes. | ||
|
|
||
| Original text courtesy of the Django project. | ||
| # Contributor Covenant Code of Conduct | ||
|
|
||
| ## Our Pledge | ||
|
|
||
| In the interest of fostering an open and welcoming environment, we as | ||
| contributors and maintainers pledge to make participation in our project and | ||
| our community a harassment-free experience for everyone, regardless of age, | ||
| body size, disability, ethnicity, sex characteristics, gender identity and | ||
| expression, level of experience, education, socio-economic status, 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 | ||
|
|
||
| ## Our Responsibilities | ||
|
|
||
| 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. | ||
|
|
||
| ## Scope | ||
|
|
||
| This Code of Conduct applies within all project spaces, and it also applies when | ||
| an individual is representing the project or its community in public spaces. | ||
| 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. | ||
|
|
||
| ## Enforcement | ||
|
|
||
| Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
| reported by contacting the project team at [im-support](mailto:[email protected]). | ||
| All complaints will be reviewed and investigated and will result in a response | ||
| that is deemed necessary and 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. | ||
|
|
||
| ## Attribution | ||
|
|
||
| This Code of Conduct is adapted from the [Contributor Covenant][homepage], | ||
| version 1.4, available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html> | ||
|
|
||
| [homepage]: <https://www.contributor-covenant.org> | ||
|
|
||
| For answers to common questions about this code of conduct, see | ||
| <https://www.contributor-covenant.org/faq>. |
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 |
|---|---|---|
| @@ -1,27 +1,59 @@ | ||
| # Contributing | ||
|
|
||
| ## Introduction | ||
| Contributions are welcome, and they are greatly appreciated! | ||
| When contributing to this repository, please first discuss the change you wish | ||
| to make via issue, email, or any other method with the owners of this | ||
| repository before making a change. | ||
|
|
||
| Thanks for considering contributing to Infrastructure Manager (IM). | ||
| Contributions to IM are welcome. | ||
| You can contribute by improving the documentation, submit bug reports, | ||
| provide feature requests, or writing code for IM. | ||
| Please note we have a [code of conduct](CODE_OF_CONDUCT.md), please follow it | ||
| in all your interactions with the project. | ||
|
|
||
| ## How to report a bug | ||
| ## Reporting bugs | ||
|
|
||
| If you find a security vulnerability, do NOT open an issue. | ||
| Email [email protected] instead. | ||
| Report bugs at <https://github.com/grycap/im/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. | ||
| * If you can, provide detailed steps to reproduce the bug. | ||
| * If you don't have steps to reproduce the bug, just note your observations in | ||
| as much detail as you can. Questions to start a discussion about the issue | ||
| are welcome. | ||
|
|
||
| ### Submit Feedback | ||
|
|
||
| The best way to send feedback is to file an issue at the follwing URL: | ||
|
|
||
| Other issues and or feature enhancements can be communicated on GitHub | ||
| <https://github.com/grycap/im/issues> | ||
|
|
||
| ## Code contributions | ||
| If you are proposing a feature: | ||
|
|
||
| * Explain in detail how it would work. | ||
| * Keep the scope as narrow as possible, to make it easier to implement. | ||
| * Remember that this is a volunteer-driven project, and that contributions | ||
| are welcome :) | ||
|
|
||
| ## Pull Request Process | ||
|
|
||
| You are welcome to open Pull Requests for either fixing a bug, adding a new | ||
| feature, contributing to the documentation, etc. | ||
|
|
||
| * Perform pull requests against the devel or master branch. | ||
| * Please check you Python code with using tox: | ||
| 1. The Pull Request should include tests. | ||
| 2. For testing we use tox tool, update tox.ini file correspondingly. | ||
| 3. The Pull Request should work for Python 3.6 and above. | ||
| 4. Increase the version numbers in any examples files and the README.md to | ||
| the new version that this Pull Request would represent. The versioning | ||
| scheme we use is [SemVer](http://semver.org/). | ||
| 5. If the Pull Request adds functionality, the docs should be updated. Put your | ||
| new functionality into a function with a docstring | ||
| ([Sphinx docstring format](https://sphinx-rtd-tutorial.readthedocs.io/en/latest/docstrings.html)), | ||
| and add the feature in the appropriate place in sphinx docs (`docs/source` directory). | ||
| 6. Update the README.md with details of changes to the interface, this includes | ||
| new environment variables, exposed ports, useful file locations and container parameters. | ||
|
|
||
| ```sh | ||
| tox -e py3,style | ||
| ``` | ||
| ## Coding Standards | ||
|
|
||
| * For new features please also provide unit tests. | ||
| * PEP8 with line length of 120 characters. | ||
| * Write new code in Python 3 | ||
| * [Sphinx docstring format](https://sphinx-rtd-tutorial.readthedocs.io/en/latest/docstrings.html) |
Oops, something went wrong.