Skip to content

Commit 4f3725e

Browse files
committed
document: add contributing.md
1 parent 8690d4f commit 4f3725e

File tree

2 files changed

+24
-0
lines changed

2 files changed

+24
-0
lines changed

.github/CONTRIBUTING.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Contributing
2+
Thanks for thinking of contributing this repository.
3+
4+
## How Can I Contribute?
5+
### Reporting Issue
6+
If you want report issue, you do not have to think deeply. Let's report according to the prepared Issue Template.
7+
8+
### Pull Request
9+
If you found cleary issue solution, please create pull request. In creating pull request, you should use prepared develop environment.
10+
11+
1. Download [Visual Studio Code](https://code.visualstudio.com/)
12+
1. Fork this repository and clone forked repository to your PC
13+
1. Checkout new branch from master
14+
1. Open forked repository by Visual Studio Code and install recommendation extensions
15+
- `dbaeumer.vscode-eslint` and `esbenp.prettier-vscode` should be installed, used by format codes
16+
- `bierner.markdown-preview-github-styles` is optional recommendation, used by preview markdown
17+
1. Writing codes
18+
1. Do debug build use `npm run build`
19+
1. Commit and push
20+
- Do not need to run `npm run pack`, because automated by CI
21+
1. Create Pull Request

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,5 +109,8 @@ jobs:
109109
```
110110
danger-action can escape path of `Gemfile`. so you can put Gemfile on no-current directory.
111111

112+
## Contributing
113+
see [Contributing.md](./.github/CONTRIBUTING.md)
114+
112115
## License
113116
[MIT License](LICENSE).

0 commit comments

Comments
 (0)