Skip to content
This repository was archived by the owner on Oct 24, 2019. It is now read-only.

Commit 32c5698

Browse files
author
DongWoo Kim
committed
chore: add md files
1 parent 7efd53d commit 32c5698

File tree

3 files changed

+147
-0
lines changed

3 files changed

+147
-0
lines changed

CODE_OF_CONDUCT.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
Contributor Covenant Code of Conduct
2+
Our Pledge
3+
4+
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.
5+
Our Standards
6+
7+
Examples of behavior that contributes to creating a positive environment include:
8+
9+
Using welcoming and inclusive language
10+
Being respectful of differing viewpoints and experiences
11+
Gracefully accepting constructive criticism
12+
Focusing on what is best for the community
13+
Showing empathy towards other community members
14+
15+
Examples of unacceptable behavior by participants include:
16+
17+
The use of sexualized language or imagery and unwelcome sexual attention or advances
18+
Trolling, insulting/derogatory comments, and personal or political attacks
19+
Public or private harassment
20+
Publishing others' private information, such as a physical or electronic address, without explicit permission
21+
Other conduct which could reasonably be considered inappropriate in a professional setting
22+
23+
Our Responsibilities
24+
25+
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.
26+
27+
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.
28+
Scope
29+
30+
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.
31+
Enforcement
32+
33+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [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.
34+
35+
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.
36+
Attribution
37+
38+
This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

CONTRIBUTING.md

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
Contributing to TOAST UI
2+
3+
First off, thanks for taking the time to contribute! 🎉 😘 ✨
4+
5+
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.
6+
Reporting Bugs
7+
8+
Bugs are tracked as GitHub issues. Search the list and try reproduce on demo before you create an issue. When you create an issue, please provide the following information by filling in the template.
9+
10+
Explain the problem and include additional details to help maintainers reproduce the problem:
11+
12+
Use a clear and descriptive title for the issue to identify the problem.
13+
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.
14+
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.
15+
Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
16+
Explain which behavior you expected to see instead and why.
17+
Include screenshots and animated GIFs which show you following the described steps and clearly demonstrate the problem.
18+
19+
Suggesting Enhancements
20+
21+
In case you want to suggest for TOAST UI Editor, please follow this guideline to help maintainers and the community understand your suggestion. Before creating suggestions, please check issue list if there's already a request.
22+
23+
Create an issue and provide the following information:
24+
25+
Use a clear and descriptive title for the issue to identify the suggestion.
26+
Provide a step-by-step description of the suggested enhancement in as many details as possible.
27+
Provide specific examples to demonstrate the steps. Include copy/pasteable snippets which you use in those examples, as Markdown code blocks.
28+
Include screenshots and animated GIFs which helps demonstrate the steps or point out the part of TOAST UI Editor which the suggestion is related to.
29+
Explain why this enhancement would be useful to most TOAST UI users.
30+
List some other text editors or applications where this enhancement exists.
31+
32+
First Code Contribution
33+
34+
Unsure where to begin contributing to TOAST UI? You can start by looking through these document, good first issue and help wanted issues:
35+
36+
document issues: issues which should be reviewed or improved.
37+
good first issues: issues which should only require a few lines of code, and a test or two.
38+
help wanted issues: issues which should be a bit more involved than beginner issues.
39+
40+
Pull Requests
41+
Development WorkFlow
42+
43+
Set up your development environment
44+
Make change from a right branch
45+
Be sure the code passes npm run lint
46+
Make a pull request
47+
48+
Development environment
49+
50+
Prepare your machine node and it's packages installed.
51+
Checkout our repository
52+
Install dependencies by npm install
53+
54+
Make changes
55+
Checkout a branch
56+
57+
master: PR Base branch.
58+
production: lastest release branch with distribution files. never make a PR on this
59+
gh-pages: API docs, examples and demo
60+
61+
Check Code Style
62+
63+
Run npm run lint and make sure all the tests pass.
64+
Commit
65+
66+
Follow our commit message conventions.
67+
Yes! Pull request
68+
69+
Make your pull request, then describe your changes.
70+
Title
71+
72+
Follow other PR title format on below.
73+
74+
<Type>: Short Description (fix #111)
75+
<Type>: Short Description (fix #123, #111, #122)
76+
<Type>: Short Description (ref #111)
77+
78+
capitalize first letter of Type
79+
use present tense: 'change' not 'changed' or 'changes'
80+
81+
Description
82+
83+
If it has related to issues, add links to the issues(like #123) in the description. Fill in the Pull Request Template by check your case.
84+
Code of Conduct
85+
86+
This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].
87+
88+
This Guide is base on atom contributing guide, CocoaPods and ESLint

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2019 NHN Entertainment Corp.
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in
13+
all copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21+
THE SOFTWARE.

0 commit comments

Comments
 (0)