diff options
| author | Shin'ya Ueoka <ueokande@i-beam.org> | 2017-10-08 22:55:37 +0900 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-10-08 22:55:37 +0900 |
| commit | 892eb8a6a6d9080213f461f19a8b8435a6482237 (patch) | |
| tree | efb3451df9e26fb2e87cb474414467cd94a800ad /CONTRIBUTING.md | |
| parent | 8b9125871b59d915324176ab959bb0aed20a727a (diff) | |
| parent | 1cae87af6d9d8dcca257d1f168697d477a5d6855 (diff) | |
Merge pull request #25 from ueokande/github
Add GitHub meta files
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..7d7a27a --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,30 @@ +# Contributing + +## Report a bug or propose a new feature + +Open a new issue from [issues](https://github.com/ueokande/vim-vixen/issues). +**Ensure the issue was not already reported** by searching on GitHub under Issues. +The issue should include title and clear description. + +Pull request is also welcome to send a patch from [Pull Requests](https://github.com/ueokande/vim-vixen/pulls). +Ensure the pull request includes description, and passes tests in CI. + +## Start a development + +Clone sources into local + + git clone https://github.com/ueokande/vim-vixen + +Install dependencies: + + npm install + +Start webpack: + + npm run start + +Then open `about:debugging` in Firefox, and choose directory from "Load Temporary Add-on". +To run tests and lint: + + npm run test + npm run lint |