-
Notifications
You must be signed in to change notification settings - Fork 17
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: add contributing guide on root
- Loading branch information
1 parent
c6451d4
commit 3ea643d
Showing
2 changed files
with
164 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,73 @@ | ||
# 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, | ||
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 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 dl_javascript@nhn.com. 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 |
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,91 @@ | ||
# Contributing to TOAST UI | ||
|
||
First off, thanks for taking the time to contribute! 🎉 😘 ✨ | ||
|
||
The following is a set of guidelines for contributing to TOAST UI. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request. | ||
|
||
## Reporting Bugs | ||
Bugs are tracked as GitHub issues. Search the list and try reproduce on [demo][demo] before you create an issue. When you create an issue, please provide the following information by filling in the template. | ||
|
||
Explain the problem and include additional details to help maintainers reproduce the problem: | ||
|
||
* **Use a clear and descriptive title** for the issue to identify the problem. | ||
* **Describe the exact steps which reproduce the problem** in as many details as possible. Don't just say what you did, but explain how you did it. For example, if you moved the cursor to the end of a line, explain if you used a mouse or a keyboard. | ||
* **Provide specific examples to demonstrate the steps.** Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets on the issue, use Markdown code blocks. | ||
* **Describe the behavior you observed after following the steps** and point out what exactly is the problem with that behavior. | ||
* **Explain which behavior you expected to see instead and why.** | ||
* **Include screenshots and animated GIFs** which show you following the described steps and clearly demonstrate the problem. | ||
|
||
## Suggesting Enhancements | ||
In case you want to suggest for a TOAST UI product, please follow this guideline to help maintainers and the community understand your suggestion. | ||
Before creating suggestions, please check [issue list](../../../labels/feature%20request) if there's already a request. | ||
|
||
Create an issue and provide the following information: | ||
|
||
* **Use a clear and descriptive title** for the issue to identify the suggestion. | ||
* **Provide a step-by-step description of the suggested enhancement** in as many details as possible. | ||
* **Provide specific examples to demonstrate the steps.** Include copy/pasteable snippets which you use in those examples, as Markdown code blocks. | ||
* **Include screenshots and animated GIFs** which helps demonstrate the steps or point out the part of a TOAST UI product which the suggestion is related to. | ||
* **Explain why this enhancement would be useful** to most TOAST UI users. | ||
* **List some other products where this enhancement exists.** | ||
|
||
## First Code Contribution | ||
|
||
Unsure where to begin contributing to TOAST UI? You can start by looking through these `document`, `good first issue` and `help wanted` issues: | ||
|
||
* **document issues**: issues which should be reviewed or improved. | ||
* **good first issues**: issues which should only require a few lines of code, and a test or two. | ||
* **help wanted issues**: issues which should be a bit more involved than beginner issues. | ||
|
||
## Pull Requests | ||
|
||
### Development WorkFlow | ||
- Set up your development environment | ||
- Make change from a right branch | ||
- Be sure the code passes `npm run test` | ||
- Make a pull request | ||
|
||
### Development environment | ||
- Prepare your machine node and it's packages installed. | ||
- Checkout our repository | ||
- Install dependencies by `npm install && bower install` | ||
- Start webpack-dev-server by `npm run serve` | ||
|
||
### Make changes | ||
#### Checkout a branch | ||
- **develop**: PR base branch. merge features, updates for next minor or major release | ||
- **master**: bug fix or document update for next patch release. develop branch will rebase every time master branch update. so keep code change to a minimum. | ||
- **production**: lastest release branch with distribution files. never make a PR on this | ||
- **gh-pages**: API docs, examples and demo | ||
|
||
#### Check Code Style | ||
Run `npm run eslint` and make sure all the tests pass. | ||
|
||
#### Test | ||
Run `npm run test` and verify all the tests pass. | ||
If you are adding new commands or features, they must include tests. | ||
If you are changing functionality, update the tests if you need to. | ||
|
||
#### Commit | ||
Follow our [commit message conventions](./docs/COMMIT_MESSAGE_CONVENTION.md). | ||
|
||
### Yes! Pull request | ||
Make your pull request, then describe your changes. | ||
#### Title | ||
Follow other PR title format on below. | ||
``` | ||
<Type>: Short Description (fix #111) | ||
<Type>: Short Description (fix #123, #111, #122) | ||
<Type>: Short Description (ref #111) | ||
``` | ||
* capitalize first letter of Type | ||
* use present tense: 'change' not 'changed' or 'changes' | ||
|
||
#### Description | ||
If it has related to issues, add links to the issues(like `#123`) in the description. | ||
Fill in the [Pull Request Template](./docs/PULL_REQUEST_TEMPLATE.md) by check your case. | ||
|
||
## Code of Conduct | ||
This project and everyone participating in it is governed by the [Code of Conducting](CODE_OF_CONDUCTING.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to dl_javascript@nhn.com. | ||
|
||
> This Guide is base on [atom contributing guide](https://github.com/atom/atom/blob/master/CONTRIBUTING.md), [CocoaPods](http://guides.cocoapods.org/contributing/contribute-to-cocoapods.html) and [ESLint](http://eslint.org/docs/developer-guide/contributing/pull-requests) |