|
1 | | -First off, thanks for taking the time to contribute! |
2 | | -The following are a set of guidelines to improve the quality of your contributions, please follow them accordingly. |
| 1 | +Thank you for taking the time to contribute! |
| 2 | +Please, follow these rules when making contributions. |
3 | 3 |
|
4 | | -# Pull requests |
5 | | -1. All pull requests are welcome, but you are required to version bump `package.json` and `README.md`. |
6 | | -2. You are required to confirm that you've tested your code. |
7 | | -3. Guideline 2 does not apply on, but is not limited to; spelling/grammar improvements, small tweaks and image additions. |
8 | | -4. Please do not change `CHANGELOG.md`, this is reserved for contributors with write access. |
| 4 | +# Unwanted contributions |
| 5 | +1. Spelling/Grammar changes |
| 6 | +2. Style violations fixes |
| 7 | +3. ESLint rules changes |
| 8 | +4. Custom command issues (except internal problems) |
| 9 | +5. Alias additions, only applies if no new default commands are provided |
| 10 | +6. Issues that come forth from using user accounts instead of bot accounts |
9 | 11 |
|
10 | | -# Issues |
11 | | -1. If submitting a bug report, include any log files (excluding chatlogs) with your issue. |
12 | | -2. If submitting a improvement suggestion, explain why you want this feature included, you don't have to go into details. |
13 | | -3. Please do not open issues if you're not sure about the cause of the problem. |
| 12 | +# Wanted contributions rules |
| 13 | +Everything that doesn't fit in the Unwanted category are considered wanted. |
| 14 | +## Commands |
| 15 | +1. Make sure commands you're adding are suitable to be default ones, if you think that some command are better suited as custom ones, edit the [wiki page](wiki wow) to include those commands instead of including them as defaults. |
14 | 16 |
|
15 | | -# Code guidelines |
16 | | -1. All commands go in `commands.js`, no exceptions. |
17 | | -2. Additional files needed by commands go in the `runtime` folder, with the exception for images and music. |
18 | | -3. Usage of ES6 code is allowed. |
19 | | -4. You are free to require additional node modules, but include them in `package.json` if you do. |
20 | | -5. When adding something users would like to disable/enable, include a `config.json` value that will trigger/disable the function. |
21 | | -6. When calling the bots name, use `bot.user` or `bot.user.username`, and not WildBeast or DougleyBot. |
22 | | -7. Try to modulate as much of your code as possible, for example; if your code needs a rss feed, try to modulate the calling for the feed. |
23 | | - |
24 | | -# Logging |
25 | | -1. When logging something that users need to see, log them using the `Logger.log("level", "message")` function, or it's shortcut `Logger.level("message")`, **Not** via `console.log`. |
26 | | -2. When *debug* logging something, log them using the `Debug.debuglogSomething("invocation", "message", "loglev")`. |
27 | | -3. When *verbose* logging something, log them using the `Debug.verboselogSomething("invocation", "message", "loglev")` |
28 | | -4. `Logger.log` takes `verbose, info, debug, warn, error` as loglevels, `Debug.debuglogSomething` and `Debug.verboselogSomething` takes loglev's present in the `loglevs.json` file located in the runtime folder. |
29 | | -5. Debug loggers won't check for a correct loglev, but refrain from using levels that aren't defined in `loglevs.json`. |
| 17 | +## Code style |
| 18 | +1. We follow the [JavaScript Standard Style](https://github.com/feross/standard), please format your code accordingly. |
| 19 | +2. [ESLint](http://eslint.org/) is used to identify other style violations, so please lint your code before committing. |
| 20 | +3. Make sure you've run `npm test` to confirm you don't break any style rules. |
0 commit comments