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

Commit 1c1e49a

Browse files
author
DongWoo Kim
committed
docs: issue/pr templates, commit message convention
1 parent d62279c commit 1c1e49a

File tree

3 files changed

+115
-0
lines changed

3 files changed

+115
-0
lines changed

docs/COMMIT_MESSAGE_CONVENTION.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Commit Message Convention
2+
3+
## Commit Message Format
4+
5+
```
6+
<Type>: Short description (fix #1234)
7+
8+
Logger description here if necessary
9+
10+
BREAKING CHANGE: only contain breaking change
11+
```
12+
* Any line of the commit message cannot be longer 100 characters!
13+
14+
## Revert
15+
```
16+
revert: commit <short-hash>
17+
18+
This reverts commit <full-hash>
19+
More description if needed
20+
```
21+
22+
## Type
23+
Must be one of the following:
24+
25+
* **feat**: A new feature
26+
* **fix**: A bug fix
27+
* **docs**: Documentation only changes
28+
* **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
29+
* **refactor**: A code change that neither fixes a bug nor adds a feature
30+
* **perf**: A code change that improves performance
31+
* **test**: Adding missing or correcting existing tests
32+
* **chore**: Changes to the build process or auxiliary tools and libraries such as documentation generation
33+
34+
## Subject
35+
* use the imperative, __present__ tense: "change" not "changed" nor "changes"
36+
* don't capitalize the first letter
37+
* no dot (.) at the end
38+
* reference GitHub issues at the end. If the commit doesn’t completely fix the issue, then use `(refs #1234)` instead of `(fixes #1234)`.
39+
40+
## Body
41+
42+
* use the imperative, __present__ tense: "change" not "changed" nor "changes".
43+
* the motivation for the change and contrast this with previous behavior.
44+
45+
## BREAKING CHANGE
46+
* This commit contains breaking change(s).
47+
* start with the word BREAKING CHANGE: with a space or two newlines. The rest of the commit message is then used for this.
48+
49+
This convention is based on [AngularJS](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#commits) and [ESLint](https://eslint.org/docs/developer-guide/contributing/pull-requests#step2)

docs/ISSUE_TEMPLATE.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
<!--
2+
Thank you for your contribution.
3+
4+
When writing an issue, please, use the template below.
5+
It's mandatory to use the template for submitting the new issue.
6+
We don't reply to the issue not following the template.
7+
-->
8+
9+
<!-- BUG ISSUE TEMPLATE -->
10+
## Version
11+
<!-- Write the version of the toast-ui.vue-grid you are currently using. -->
12+
13+
## Test Environment
14+
<!-- Write the browser type, OS and so on -->
15+
16+
## Current Behavior
17+
<!-- Write steps to reproduce the current behaviour in detail.
18+
You can add sample code, 'CodePen' or 'jsfiddle' links. -->
19+
20+
```js
21+
// Write example code
22+
```
23+
24+
## Expected Behavior
25+
<!-- Write a description for future action. -->

docs/PULL_REQUEST_TEMPLATE.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
<!-- EDIT TITLE PLEASE -->
2+
<!-- It should be one of them
3+
<ISSUE TYPE>: Short Description (<CLOSING TYPE> #<ISSUE NUMBERS>)
4+
ex)
5+
feat: add new feature (close #111)
6+
fix: wrong behavior (fix #111)
7+
chore: change build tool (ref #111)
8+
-->
9+
10+
<!-- SPECIFY A ISSUE TYPE AT HEAD
11+
feat: A new feature
12+
fix: A bug fix
13+
docs: Documentation only changes
14+
style: Changes that do not affect the meaning of the code (white-space, formatting etc)
15+
refactor: A code change that neither fixes a bug or adds a feature
16+
perf: A code change that improves performance
17+
test: Adding missing tests
18+
chore: Changes to the build process or auxiliary tools and libraries such as documentation generation
19+
-->
20+
21+
<!-- ADD CLOSING TYPE AND ISSUE NUMBER AT TAIL
22+
(<CLOSING TYPE> #<ISSUE NUMBERS>)
23+
close: resolve not a bug(feature, docs, etc) completely
24+
fix: resolve a bug completely
25+
ref: not fully resolved or related to
26+
-->
27+
28+
### Please check if the PR fulfills these requirements
29+
- [ ] It's the right issue type on the title
30+
- [ ] When resolving a specific issue, it's referenced in the PR's title (e.g. `fix #xxx[,#xxx]`, where "xxx" is the issue number)
31+
- [ ] The commit message follows our guidelines
32+
- [ ] Tests for the changes have been added (for bug fixes/features)
33+
- [ ] Docs have been added/updated (for bug fixes/features)
34+
- [ ] It does not introduce a breaking change or has a description of the breaking change
35+
36+
### Description
37+
38+
39+
40+
---
41+
Thank you for your contribution to TOAST UI product. 🎉 😘 ✨

0 commit comments

Comments
 (0)