You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+33-17Lines changed: 33 additions & 17 deletions
Original file line number
Diff line number
Diff line change
@@ -5,87 +5,103 @@ First off, thanks for taking the time to contribute! 🎉 😘 ✨
5
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
6
7
7
## Reporting Bugs
8
+
8
9
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.
9
10
10
11
Explain the problem and include additional details to help maintainers reproduce the problem:
11
12
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.
13
+
-**Use a clear and descriptive title** for the issue to identify the problem.
14
+
-**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.
15
+
-**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.
16
+
-**Describe the behavior you observed after following the steps** and point out what exactly is the problem with that behavior.
17
+
-**Explain which behavior you expected to see instead and why.**
18
+
-**Include screenshots and animated GIFs** which show you following the described steps and clearly demonstrate the problem.
18
19
19
20
## Suggesting Enhancements
21
+
20
22
In case you want to suggest for TOAST UI ImageEditor, please follow this guideline to help maintainers and the community understand your suggestion.
21
23
Before creating suggestions, please check [issue list](../../labels/enhancement) if there's already a request.
22
24
23
25
Create an issue and provide the following information:
24
26
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 ImageEditor which the suggestion is related to.
29
-
***Explain why this enhancement would be useful** to most TOAST UI users.
30
-
***List some other image editors or applications where this enhancement exists.**
27
+
-**Use a clear and descriptive title** for the issue to identify the suggestion.
28
+
-**Provide a step-by-step description of the suggested enhancement** in as many details as possible.
29
+
-**Provide specific examples to demonstrate the steps.** Include copy/pasteable snippets which you use in those examples, as Markdown code blocks.
30
+
-**Include screenshots and animated GIFs** which helps demonstrate the steps or point out the part of TOAST UI ImageEditor which the suggestion is related to.
31
+
-**Explain why this enhancement would be useful** to most TOAST UI users.
32
+
-**List some other image editors or applications where this enhancement exists.**
31
33
32
34
## First Code Contribution
33
35
34
36
Unsure where to begin contributing to TOAST UI? You can start by looking through these `document`, `good first issue` and `help wanted` issues:
35
37
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.
38
+
-**document issues**: issues which should be reviewed or improved.
39
+
-**good first issues**: issues which should only require a few lines of code, and a test or two.
40
+
-**help wanted issues**: issues which should be a bit more involved than beginner issues.
39
41
40
42
## Pull Requests
41
43
42
44
### Development WorkFlow
45
+
43
46
- Set up your development environment
44
47
- Make change from a right branch
45
48
- Be sure the code passes `npm run lint`, `npm run test`
46
49
- Make a pull request
47
50
48
51
### Development environment
52
+
49
53
- Prepare your machine node and it's packages installed.
50
54
- Checkout our repository
51
55
- Install dependencies by `npm install && bower install`
52
56
- Start webpack-dev-server by `npm run serve`
53
57
54
58
### Make changes
59
+
55
60
#### Checkout a branch
61
+
56
62
-**develop**: PR base branch. merge features, updates for next minor or major release
57
63
-**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.
58
64
-**production**: lastest release branch with distribution files. never make a PR on this
59
65
-**gh-pages**: API docs, examples and demo
60
66
61
67
#### Check Code Style
68
+
62
69
Run `npm run eslint` and make sure all the tests pass.
63
70
64
71
#### Test
72
+
65
73
Run `npm run test` and verify all the tests pass.
66
74
If you are adding new commands or features, they must include tests.
67
75
If you are changing functionality, update the tests if you need to.
Make your pull request, then describe your changes.
84
+
74
85
#### Title
86
+
75
87
Follow other PR title format on below.
88
+
76
89
```
77
90
<Type>: Short Description (fix #111)
78
91
<Type>: Short Description (fix #123, #111, #122)
79
92
<Type>: Short Description (ref #111)
80
93
```
81
-
* capitalize first letter of Type
82
-
* use present tense: 'change' not 'changed' or 'changes'
94
+
95
+
- capitalize first letter of Type
96
+
- use present tense: 'change' not 'changed' or 'changes'
83
97
84
98
#### Description
99
+
85
100
If it has related to issues, add links to the issues(like `#123`) in the description.
86
101
Fill in the [Pull Request Template](./docs/PULL_REQUEST_TEMPLATE.md) by check your case.
87
102
88
103
## Code of Conduct
104
+
89
105
This project and everyone participating in it is governed by the [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to dl_javascript@nhn.com.
90
106
91
107
> 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)
0 commit comments