aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
blob: 4b620664128aced959731fd862fe941f28cfda85 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
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 a 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:

    yarn install

Start webpack:

    yarn start

Then open `about:debugging` in Firefox, and choose directory from "Load Temporary Add-on".
To run tests and lint:

    yarn test
    yarn lint