From b776bd20997e8cd4b9a7877cd999aa51798b5912 Mon Sep 17 00:00:00 2001 From: MeilCli Date: Fri, 1 Jan 2021 20:25:40 +0900 Subject: [PATCH] document: add contributing.md --- .github/CONTRIBUTING.md | 21 +++++++++++++++++++++ README.md | 3 +++ 2 files changed, 24 insertions(+) create mode 100644 .github/CONTRIBUTING.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 00000000..4edff612 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,21 @@ +# Contributing +Thanks for thinking of contributing this repository. + +## How Can I Contribute? +### Reporting Issue +If you want report issue, you do not have to think deeply. Let's report according to the prepared Issue Template. + +### Pull Request +If you found cleary issue solution, please create pull request. In creating pull request, you should use prepared develop environment. + +1. Download [Visual Studio Code](https://code.visualstudio.com/) +1. Fork this repository and clone forked repository to your PC +1. Checkout new branch from master +1. Open forked repository by Visual Studio Code and install recommendation extensions + - `dbaeumer.vscode-eslint` and `esbenp.prettier-vscode` should be installed, used by format codes + - `bierner.markdown-preview-github-styles` is optional recommendation, used by preview markdown +1. Writing codes +1. Do debug build use `npm run build` +1. Commit and push + - Do not need to run `npm run pack`, because automated by CI +1. Create Pull Request \ No newline at end of file diff --git a/README.md b/README.md index 1fe8dbb8..8dd251c4 100644 --- a/README.md +++ b/README.md @@ -82,6 +82,9 @@ jobs: - run: 'echo ${{ fromJson(steps.message.outputs.response).file.permalink }}' ``` +## Contributing +see [Contributing.md](./.github/CONTRIBUTING.md) + ## License MIT License