Skip to content

Commit

Permalink
document: add contributing.md
Browse files Browse the repository at this point in the history
  • Loading branch information
MeilCli committed Jan 1, 2021
1 parent b4a6663 commit b776bd2
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 0 deletions.
21 changes: 21 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,9 @@ jobs:
- run: 'echo ${{ fromJson(steps.message.outputs.response).file.permalink }}'
```

## Contributing
see [Contributing.md](./.github/CONTRIBUTING.md)

## License
MIT License

Expand Down

0 comments on commit b776bd2

Please sign in to comment.