File tree Expand file tree Collapse file tree 1 file changed +29
-0
lines changed
Expand file tree Collapse file tree 1 file changed +29
-0
lines changed Original file line number Diff line number Diff line change 1+ # Contributing
2+
3+ ## Code style
4+ Regarding code style like indentation and whitespace, ** follow the conventions you see used in the source already.**
5+
6+ ## Modifying the code
7+
8+ Please don't edit ` /dist/slideout.js ` and ` /dist/slideout.min.js ` files. You'll find source code in the ` index.js ` file.
9+
10+ 1 . Fork and clone the repo.
11+ 2 . Run ` npm install ` to install all dependencies.
12+ 3 . Create a new branch, please don't work in your ` master ` branch directly.
13+ 4 . Open the file ` /test/index.html ` .
14+ 5 . Code!
15+
16+ ### Running the tests
17+
18+ - Run ` npm test ` from your command line and check the console
19+ - Open the ` /test/index.html ` file to run test in your browser.
20+
21+ ## Pull requests
22+
23+ 1 . Create a new branch, ** please don't work in your ` master ` branch directly** .
24+ 2 . Code!
25+ 3 . Update the tests and run ` npm test ` to see the tests.
26+ 4 . Run ` npm run hint ` .
27+ 5 . Run ` npm run dist ` to build a new version.
28+ 6 . Update the documentation and package to reflect any changes.
29+ 7 . Push to your fork and submit a pull request.
You can’t perform that action at this time.
0 commit comments