Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add badge, code_of_conduct and contributing instructions
- Loading branch information
Showing
3 changed files
with
100 additions
and
0 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,46 @@ | ||
| # Contributor Covenant Code of Conduct | ||
|
|
||
| ## Our Pledge | ||
|
|
||
| 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. | ||
|
|
||
| ## 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 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. | ||
|
|
||
| ## Enforcement | ||
|
|
||
| Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at crownpku@gmail.com. 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. | ||
|
|
||
| ## Attribution | ||
|
|
||
| This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version] | ||
|
|
||
| [homepage]: http://contributor-covenant.org | ||
| [version]: http://contributor-covenant.org/version/1/4/ |
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
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,53 @@ | ||
| # Contribution Guidelines | ||
|
|
||
| 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. | ||
|
|
||
| # The pull request should have a useful title. Pull requests with `Update readme.md` as title will be closed right away because I'm so tired of nobody reading this document. Please carefully read everything in `Adding to this list`. | ||
|
|
||
| ## Table of Contents | ||
|
|
||
| - [Adding to this list](#adding-to-this-list) | ||
| - [Creating your own awesome list](#creating-your-own-awesome-list) | ||
| - [Adding something to an awesome list](#adding-something-to-an-awesome-list) | ||
| - [Updating your Pull Request](#updating-your-pull-request) | ||
|
|
||
| ## Adding to this list | ||
|
|
||
| Please ensure your pull request adheres to the following guidelines: | ||
|
|
||
| - Search previous suggestions before making a new one, as yours may be a duplicate. | ||
| - Make sure the list is useful before submitting. That implies it has enough content and every item has a good succinct description. | ||
| - Make an individual pull request for each suggestion. | ||
| - Use [title-casing](http://titlecapitalization.com) (AP style). | ||
| - Use the following format: `[List Name](link)` | ||
| - Link additions should be added to the bottom of the relevant category. | ||
| - New categories or improvements to the existing categorization are welcome. | ||
| - Check your spelling and grammar. | ||
| - Make sure your text editor is set to remove trailing whitespace. | ||
| - The pull request and commit should have a useful title. | ||
| - The body of your commit message should contain a link to the repository. | ||
|
|
||
| Thank you for your suggestions! | ||
|
|
||
| ## Creating your own awesome list | ||
|
|
||
| To create your own list, check out the [instructions](create-list.md). | ||
|
|
||
| ## Adding something to an awesome list | ||
|
|
||
| If you have something awesome to contribute to an awesome list, this is how you do it. | ||
|
|
||
| You'll need a [GitHub account](https://github.com/join)! | ||
|
|
||
| 1. Access the awesome list's GitHub page. For example: https://github.com/sindresorhus/awesome | ||
| 2. Click on the `readme.md` file:  | ||
| 3. Now click on the edit icon.  | ||
| 4. You can start editing the text of the file in the in-browser editor. Make sure you follow guidelines above. You can use [GitHub Flavored Markdown](https://help.github.com/articles/github-flavored-markdown/).  | ||
| 5. Say why you're proposing the changes, and then click on "Propose file change".  | ||
| 6. Submit the [pull request](https://help.github.com/articles/using-pull-requests/)! | ||
|
|
||
| ## Updating your Pull Request | ||
|
|
||
| Sometimes, a maintainer of an awesome list will ask you to edit your Pull Request before it is included. This is normally due to spelling errors or because your PR didn't match the awesome-* list guidelines. | ||
|
|
||
| [Here](https://github.com/RichardLitt/knowledge/blob/master/github/amending-a-commit-guide.md) is a write up on how to change a Pull Request, and the different ways you can do that. |