|
1 | 1 | # Contributing |
2 | | -Anyone can contribute to this repo, so long as you don't break anything on purpose. |
3 | 2 |
|
| 3 | +Anyone can contribute to this repo, so long as you don't break anything on purpose. |
4 | 4 |
|
5 | 5 | ## Bug reporting |
| 6 | + |
6 | 7 | Please [report any errors](https://github.com/jerone/UserScripts/issues/new) you're having with one of the scripts. This will help you and others and make the script better. |
7 | 8 |
|
8 | 9 | When reporting an issue include the script name in the title and follow the template below for it's description: |
9 | 10 |
|
10 | | -> **Script**: `{name}` `{version}`<br /> |
11 | | -> **Browser**: `{name}` `{version}`<br /> |
12 | | -> **Addon** (e.g. Tampermonkey): `{name}` `{version}`<br /> |
13 | | -> **Error Message**: `{message}`<br /> |
14 | | -> **Screenshot**: `{drag&drop}`<br /> |
15 | | -> **Description**: `{description}`<br /> |
16 | | -
|
17 | | -**Or click [here](https://github.com/jerone/UserScripts/issues/new?title=%28{script%20name}%29%20{summary}&body=**Script**%3A%20{name}%20{version}%0A**Browser**%3A%20{name}%20{version}%0A**Addon**%20%28e.g.%20Tampermonkey%29%3A%20{name}%20{version}%0A**Error%20Message**%3A%20%60{message}%60%0A**Screenshot**%3A%20{drag%26drop}%0A**Description**%3A%20{description}) to open a new issue.** |
| 11 | +> **Script**: `{name}` `{version}`<br /> **Browser**: `{name}` `{version}`<br /> **Addon** (e.g. Tampermonkey): `{name}` `{version}`<br /> **Error Message**: `{message}`<br /> **Screenshot**: `{drag&drop}`<br /> **Description**: `{description}`<br /> |
18 | 12 |
|
| 13 | +Or click [here](https://github.com/jerone/UserScripts/issues/new?title=%28{script%20name}%29%20{summary}&body=**Script**%3A%20{name}%20{version}%0A**Browser**%3A%20{name}%20{version}%0A**Addon**%20%28e.g.%20Tampermonkey%29%3A%20{name}%20{version}%0A**Error%20Message**%3A%20%60{message}%60%0A**Screenshot**%3A%20{drag%26drop}%0A**Description**%3A%20{description}) to open a new issue. |
19 | 14 |
|
20 | 15 | ## Bug fixes |
21 | | -If you find any sort of error, spelling mistake, etc. in this project, feel free to fix it and submit a [pull request](https://github.com/jerone/UserScripts/pulls) with your commit. Little fixes like this are welcomed and are usually accepted pretty quickly. |
22 | 16 |
|
| 17 | +If you find any sort of error, spelling mistake, etc. in this project, feel free to fix it and submit a [pull request](https://github.com/jerone/UserScripts/pulls) with your commit. Little fixes like this are welcomed and are usually accepted pretty quickly. |
23 | 18 |
|
24 | 19 | ## Feature requests |
25 | | -Time is limited, so feature requests are discussed and released when possible and time permits. You can always send a [pull request](https://github.com/jerone/UserScripts/pulls) to speed up the process. |
26 | 20 |
|
| 21 | +Time is limited, so feature requests are discussed and released when possible and time permits. You can always send a [pull request](https://github.com/jerone/UserScripts/pulls) to speed up the process. |
27 | 22 |
|
28 | 23 | ## Code style |
29 | | -Many conventions are available for writing code, but in this repo there's only one correct and that's mine :) |
30 | 24 |
|
31 | | -Please use the following conventions: |
| 25 | +Many conventions are available for writing code, but in this repo there's only one correct and that's mine 😊 |
32 | 26 |
|
33 | | -* Tabs over spaces. |
34 | | -* My tabs are 4 spaces width. |
35 | | -* Always append JavaScript with an `;`. |
36 | | -* End files with a newline. |
37 | | -* Try to obey [JSHint](http://jshint.com) rules. |
38 | | -* Install [EditorConfig](http://editorconfig.org) to help with above and more rules. |
39 | | -* Follow the conventions you see used in the source already. |
| 27 | +Please use the following conventions: |
40 | 28 |
|
| 29 | +- Obey to linting (ESLint) rules. You can run them via `npm run lint`. |
| 30 | +- Install [EditorConfig](http://editorconfig.org) to help. |
| 31 | +- Follow the conventions you see used in the source already. |
41 | 32 |
|
42 | 33 | ## Git Commit Messages |
43 | 34 |
|
44 | | -* Use the past tense ("Added feature" not "Add feature"). |
45 | | -* Limit the first line to 72 characters or less. |
46 | | -* Reference issues and pull requests liberally. |
47 | | -* Consider starting the commit message with an applicable emoji: |
48 | | - * :bug: `:bug:` when fixing a bug. |
49 | | - * :sparkles: `:sparkles:` when adding a new feature. |
50 | | - * :art: `:art:` when improving the format/structure of the code. |
51 | | - * :memo: `:memo:` when writing docs. |
52 | | - * :mag: `:mag:` when adding debugging code. |
53 | | - * :fire: `:fire:` when removing code or files. |
54 | | - * :racehorse: `:racehorse:` when improving performance. |
55 | | - * :non-potable_water: `:non-potable_water:` when plugging memory leaks. |
56 | | - * :green_heart: `:green_heart:` when fixing the CI build. |
57 | | - * :white_check_mark: `:white_check_mark:` when adding tests. |
58 | | - * :lock: `:lock:` when dealing with security. |
59 | | - * :shirt: `:shirt:` when removing linter warnings. |
60 | | - * :package::arrow_up: `:package::arrow_up:` when upgrading dependencies. |
61 | | - * :package::arrow_down: `:package::arrow_down:` when downgrading dependencies. |
62 | | - * :clapper: `:clapper:` for the initial commit and project snapshots. |
63 | | - * :soon: `:soon:` for TODO messages. |
64 | | - * :checkered_flag: `:checkered_flag:` when fixing something on Windows. |
65 | | - * :penguin: `:penguin:` when fixing something on Linux. |
66 | | - * :apple: `:apple:` when fixing something on Mac OS. |
| 35 | +- Use the past tense ("Added feature" not "Add feature"). |
| 36 | +- Limit the first line to 72 characters or less. |
| 37 | +- Reference issues and pull requests liberally. |
0 commit comments