-
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.
- Loading branch information
Showing
1 changed file
with
15 additions
and
73 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,87 +1,29 @@ | ||
| # Contribution guidelines | ||
|
|
||
| > This document is inspired by the github [community guideline](https://help.github.com/articles/github-community-guidelines/) and vuejs [code of conduct](https://github.com/vuejs/vue/blob/dev/.github/CODE_OF_CONDUCT.md) | ||
| Before submitting your contribution, please make sure to take a moment and read through the following guidelines. | ||
|
|
||
| - [Community guidelines](/community.md) | ||
| - [Issue Reporting Guidelines](#issue-reporting-guidelines) | ||
| - [Pull Request Guidelines](#pull-request-guidelines) | ||
| - [Tests Guidelines](#tests-guidelines) | ||
|
|
||
| Github is a place where millions of developers share their perspectives, ideas and experiences. It is a welcoming environment for all different voices and perspectives. It is important to encourage and maintain projects where people are free to express themselves. | ||
| Thank you very much for your interest, we are really excited working with you. | ||
|
|
||
| By reading the following document, we pledge to communicate expectations, respect all people who contribute regardless of their experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion. | ||
| ## Issue Reporting Guidelines | ||
|
|
||
| The issue list of the repository you working on is exclusively for feature requests, ideas and bug reports. Issues that do not conform with our [code of conduct](/community.md) will be closed immediately. | ||
|
|
||
| - for questions, please refer to the twitter account or gitter chat room listed in the project README. | ||
|
|
||
| - make sure the issue entered do not already exist or been already answered (closed issues might contain the branch or software version containing the fix). | ||
|
|
||
| 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, age, or religion. | ||
| - please indicate the version you are using and try reproducing the issue with the latest stable version of the project your are working on | ||
|
|
||
| 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. | ||
| - Use clear language and describe the step necessary to reproduce the issue you are running into. Issues with no clear description will be fixed later on. | ||
|
|
||
| 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. Project maintainers who do not follow the Code of Conduct may be removed from the project team. | ||
| - It is recommended to fork the project and create a test case for your issue. See [tests guidelines]](#tests-guidelines) | ||
|
|
||
| Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers. | ||
|
|
||
| ## Pull Request Guidelines | ||
|
|
||
|
|
||
|
|
||
| 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, age, or religion. | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| By outlining what we expect to see within our community, we hope to help you understand how best to collaborate on GitHub, and what type of actions or content may violate our Terms of Service. We do not actively seek out content to moderate. We rely on our community members to communicate expectations, moderate their projects, and report abusive behavior or content. We will investigate any abuse reports and may moderate public content on our site that we determine to be in violation of our Terms of Service. | ||
|
|
||
|
|
||
|
|
||
| Building a strong community | ||
|
|
||
| The primary purpose of the GitHub community is to collaborate on software projects. We want people to work better together. Although we maintain the site, this is a community we build together, and we need your help to make it the best it can be. | ||
|
|
||
| Be welcoming and open-minded - Other collaborators may not have the same experience level or background as you, but that doesn't mean they don't have good ideas to contribute. We encourage you to be welcoming to new collaborators on your projects and discussions. | ||
|
|
||
| Assume no malice - Humans make mistakes, and disagreements or differences of opinion are a fact of life. Try to approach conflict from the perspective that people generally mean well. This will promote a respectful and friendly atmosphere where people feel comfortable asking questions, participating in discussions, and making contributions. | ||
|
|
||
| Stay on topic - People use GitHub to get work done and to be more productive. Off topic comments are a distraction (sometimes welcome, but usually not) from getting work done and being productive. Staying on topic helps produce positive and productive discussions. | ||
|
|
||
| Be clear - Communicating with strangers on the Internet can be awkward. It's hard to convey or read tone, and sarcasm is frequently misunderstood. Try to use clear language, and think about how it will be received by the other person. | ||
|
|
||
| What if something or someone offends you? | ||
|
|
||
| We rely on the community to let us know when an issue needs to be addressed. We do not actively monitor the site for offensive content. If you run into something or someone on the site that you find objectionable, here are some tools GitHub provides to help you take action immediately: | ||
|
|
||
| Communicate expectations - If you participate in a community that has not set their own, community-specific guidelines, encourage them to do so either in the README or CONTRIBUTING file, or in a dedicated code of conduct, by submitting a pull request. | ||
|
|
||
| Moderate Comments - If you have write-access privileges for a repository, you can edit or delete anyone's comments on commits, pull requests, and issues. | ||
|
|
||
| Lock Conversations - If a discussion in an issue or pull request gets out of control, you can lock the conversation. | ||
|
|
||
| Block Users - If you encounter a user who continues to demonstrate poor behavior, you can block the user from your personal account or block the user from your organization. | ||
|
|
||
| Of course, you can always contact us to Report Abuse if you need more help dealing with a situation. | ||
|
|
||
| What is not allowed? | ||
|
|
||
| Threats of violence - You may not threaten violence towards others or use the site to organize, promote, or incite acts of real-world violence or terrorism. Think carefully about the words you use, the images you post, and even the software you write, and how they may be interpreted by others. Even if you mean something as a joke, it might not be received that way. If you think that someone else might interpret the content you post as a threat, or as promoting violence or terrorism, stop. Don't post it on GitHub. In extraordinary cases, we may report threats of violence to law enforcement if we think there may be a genuine risk of physical harm or a threat to public safety. | ||
|
|
||
| Hate speech and discrimination - While it is certainly not forbidden to broach topics such as age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation, we do not tolerate speech that attacks a person or group of people on the basis of who they are. Just realize that talking about these or other sensitive topics can make others feel unwelcome, or perhaps even unsafe, if approached in an aggressive or insulting manner. We expect our community members to be respectful when discussing sensitive topics. | ||
|
|
||
| Bullying and harassment - We do not tolerate bullying or harassment. This means any habitual badgering or intimidation targeted at a specific person or group of people. In general, if your actions are unwanted and you continue to engage in them, there's a good chance you are headed into bullying or harassment territory. | ||
|
|
||
| Impersonation - You may not impersonate another person by copying their avatar, posting content under their email address, using a similar username or otherwise posing as someone else. Impersonation is a form of harassment. | ||
|
|
||
| Doxxing and invasion of privacy - Don't post other people's personal information, such as phone numbers, private email addresses, physical addresses, credit card numbers, or passwords. This is also a form of harassment as it may present safety risks or other harms. | ||
|
|
||
| Sexually explicit content - Don't post pornography. To paraphrase the U.S. Supreme Court: We'll know it when we see it. | ||
|
|
||
| Active malware or exploits - Being part of a community includes not taking advantage of other members of the community. We do not allow anyone to use our platform for exploit delivery, such as hosting malicious executables, or as attack infrastructure, for example by organizing denial of service attacks or managing command and control servers. Note, however, that we do not prohibit the posting of source code which could be used to develop malware or exploits, as the publication and distribution of such source code has educational value and provides a net benefit to the security community. | ||
|
|
||
| What happens if someone breaks the rules? | ||
|
|
||
| There are a variety of actions that we may take in response to inappropriate behavior or content. It usually depends on the exact circumstances of a particular case. We recognize that sometimes people may say or do inappropriate things for any number of reasons. Perhaps they did not realize how their words would be perceived. Or maybe they just let their emotions get the best of them. Of course, sometimes, there are folks who just want to spam or cause trouble. | ||
|
|
||
| Each case requires a different approach, and we try to tailor our response to meet the needs of the situation. We'll review each abuse report on a case-by-case basis. In each case, we will have a diverse team investigate the content and surrounding facts and respond as appropriate, using these guidelines to guide our decision. | ||
|
|
||
| Actions we may take in response to an abuse report include but are not limited to: | ||
|
|
||
| Content Removal | ||
| Content Blocking | ||
| Account Suspension | ||
| Account Termination | ||
| ## Tests Guidelines |