|
3 | 3 | Please read these guidelines before contributing code.
|
4 | 4 |
|
5 | 5 | ## :nut_and_bolt: Setting up the development environment
|
| 6 | + |
6 | 7 | - Fork and clone the repository
|
7 | 8 | - `npm install`
|
8 | 9 | - `npm run watch`
|
9 | 10 | - To update js and css files, use the `src` folder: src/js/glightbox.js and src/postcss/glightbox.css These files will be compiled automatically with every change to the `dist` folder (do not modify the dist files directly)
|
10 | 11 |
|
11 | 12 | ## :bug: Fixing a Bug
|
12 |
| -When fixing a bug please make sure to test it in several browsers including ie11. If you are not able to do so, mention that in a PR comment, so other contributors can do it. |
| 13 | + |
| 14 | +When fixing a bug please make sure to test it in several browsers including ie11. If you are not able to do so, mention that in a PR comment, so other contributors can do it. once your code is working please run the following command "eslint src/js" to verify that your code is following the same coding standards |
13 | 15 |
|
14 | 16 | ## :tada: Proposing a Change
|
15 |
| -When implementing a feature please create an issue first explaining your idea and asking whether there's need for such a feature. |
16 |
| -Remember the script's core philosophy is to stay simple and minimal, doing one thing and doing it right. |
| 17 | + |
| 18 | +When implementing a feature please create an issue first explaining your idea and asking whether there's need for such a feature. Remember the script's core philosophy is to stay simple and minimal, doing one thing and doing it right. |
17 | 19 |
|
18 | 20 | ## :pencil: Before you open a Pull Request
|
19 |
| -- Follow Git best practices (especially use meaningful commit messages). |
| 21 | + |
20 | 22 | - Follow the same conding style.
|
| 23 | +- Run eslint to verify your code, run the following command "eslint src/js" and fix any error you find in your code |
21 | 24 | - **DO NOT** commit changes in the dist directory, this files are created automatically.
|
| 25 | +- Follow Git best practices (especially use meaningful commit messages). |
22 | 26 | - Describe thoroughly you work in a PR comment.
|
23 | 27 | - Be patient and understanding. It's a side project, done in free time.
|
24 | 28 |
|
|
0 commit comments