1 | # How to contribute
|
2 |
|
3 | ## Improve documentation
|
4 |
|
5 | We are always looking to improve our documentation. If at some moment you are
|
6 | reading the documentation and something is not clear, or you can't find what you
|
7 | are looking for, then please open an issue with the repository. This gives us a
|
8 | chance to answer your question and to improve the documentation if needed.
|
9 |
|
10 | Pull requests correcting spelling or grammar mistakes are always welcome.
|
11 |
|
12 | ## Found a bug?
|
13 |
|
14 | Please try to answer at least the following questions when reporting a bug:
|
15 |
|
16 | - Which version of the project did you use when you noticed the bug?
|
17 | - How do you reproduce the error condition?
|
18 | - What happened that you think is a bug?
|
19 | - What should it do instead?
|
20 |
|
21 | It would really help the maintainers if you could provide a reduced test case
|
22 | that reproduces the error condition.
|
23 |
|
24 | ## Have a feature request?
|
25 |
|
26 | Please provide some thoughful commentary and code samples on what this feature
|
27 | should do and why it should be added (your use case). The minimal questions you
|
28 | should answer when submitting a feature request should be:
|
29 |
|
30 | - What will it allow you to do that you can't do today?
|
31 | - Why do you need this feature and how will it benefit other users?
|
32 | - Are there any drawbacks to this feature?
|
33 |
|
34 | ## Submitting a pull-request?
|
35 |
|
36 | Here are some things that will increase the chance that your pull-request will
|
37 | get accepted:
|
38 | - Did you confirm this fix/feature is something that is needed?
|
39 | - Did you write tests, preferably in a test driven style?
|
40 | - Did you add documentation for the changes you made?
|
41 | - Did you follow our [styleguide](https://github.com/dockyard/styleguides)?
|
42 |
|
43 | If your pull-request addresses an issue then please add the corresponding
|
44 | issue's number to the description of your pull-request.
|
45 |
|
46 | # How to work with this project locally
|
47 |
|
48 | ## Installation
|
49 |
|
50 | First clone this repository:
|
51 |
|
52 | ```sh
|
53 | git clone https://github.com/DockYard/ember-service-worker.git
|
54 | ```
|
55 |
|
56 | Then move into the project's directory and install the dependencies:
|
57 |
|
58 | ```sh
|
59 | cd ember-service-worker
|
60 | npm install
|
61 | bower install
|
62 | ```
|
63 |
|
64 | ## Running tests
|
65 |
|
66 | Before running the tests
|
67 | ```sh
|
68 | cd node-tests/fixtures/simple-app && npm install && bower install && cd -
|
69 | ```
|
70 |
|
71 | To run the node tests:
|
72 |
|
73 | ```sh
|
74 | npm test
|
75 | ```
|
76 |
|
77 | To run the ember tests:
|
78 |
|
79 | ```sh
|
80 | ember test
|
81 | ```
|
82 |
|
83 | ## Running the docs
|
84 | The docs site uses the Jekyll site library and requires Ruby to run locally.
|
85 | From the `docs` directory, enter the following to run locally
|
86 |
|
87 | ```sh
|
88 | bundle exec jekyll serve
|
89 | ```
|