update readme

This commit is contained in:
Jocs 2018-03-13 11:56:37 +08:00
parent 1762b1ab94
commit c5109b5395
4 changed files with 58 additions and 4 deletions

13
.github/CODE_OF_CONDUCT.md vendored Normal file
View File

@ -0,0 +1,13 @@
### Contributor 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, 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 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.
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
This Code of Conduct is adapted from the[Contributor Covenant](http://contributor-covenant.org/), version 1.0.0, available at[http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

35
.github/CONTRIBUTING.md vendored Normal file
View File

@ -0,0 +1,35 @@
### Mark Text Contributing Guide
Hi, I'm really excited that you are interested in contributing to Mark Text. Before submitting your contribution though, please make sure to take a moment and read through the following guidelines.
- [Code of Conduct](https://github.com/marktext/marktext/blob/master/.github/CODE_OF_CONDUCT.md)
- Issue Reporting Guidelines
- Pull Request Guidelines
### Issue Reporting Guidelines
Always follow the [**Issue** template](https://github.com/marktext/marktext/blob/master/.github/ISSUE_TEMPLATE.md)
### Pull Request Guidelines
- Submit the PRs directly to the `master` branch.
- Work in the `src` folder and **DO NOT** checkin `dist` in commits.
- If you adding new feature:
- Open a suggestion issue first and add appropriate label to it.
- Provide convincing reason to add this feature.
- Then submit you PRs.
- If fixing a bug:
- you are resolving a special issue, add`(fix #xxxx[,#xxx])`(#xxxx is the issue id) in your PR title for a better release log, e.g.`update entities encoding/decoding (fix #3899)`.
- Provide detailed description of the bug in the PR. Live demo or picture preferred.
- All PRs need to pass the **Travis Ci** before merged.

View File

@ -50,8 +50,14 @@ If you wish to build **Mark Text** yourself.
When you use **Mark Text**, if you have any questions, you are welcome to write an issue, but I hope you follow the format of issue. Of course, if you can submit a PR directly, it will be appreciated.
<h3 align="center">Last</h3>
<h3 align="center">Contribution</h3>
It is under [**MIT LICENSE**](https://github.com/marktext/marktext/blob/master/LICENSE).
Please make sure to read the [Contributing Guide](https://github.com/marktext/marktext/blob/master/.github/CONTRIBUTING.md) before making a pull request.
if you find **Mark Text** suitable for your needs, It's my pleasure.
Thank you to all the people who have already contributed to Mark Text!
<h3 align="center">License</h3>
[**MIT**](https://github.com/marktext/marktext/blob/master/LICENSE).
Copyright (c) 2017-present, Jocs

View File

@ -1,6 +1,6 @@
{
"name": "marktext",
"version": "0.6.12",
"version": "0.6.13",
"author": "Jocs <luoran1988@126.com>",
"description": "Next generation markdown editor",
"license": "MIT",