|
| 1 | +## How to contribute to Whateverable |
| 2 | + |
| 3 | +🍕 First off, thanks for taking the time to contribute! 🍕 |
| 4 | + |
| 5 | + |
| 6 | +If you have a question that is not covered here, just |
| 7 | +talk to a human on |
| 8 | +[#perl6 or #whateverable](https://webchat.freenode.net/?channels=#perl6,#whateverable) |
| 9 | +IRC channel on freenode. |
| 10 | + |
| 11 | + |
| 12 | +Looking for a bug to squash? See |
| 13 | +[issues marked as low-hanging fruit](https://github.com/perl6/whateverable/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22). |
| 14 | + |
| 15 | + |
| 16 | +### Reporting bugs |
| 17 | + |
| 18 | +If you found a bug, feel free to |
| 19 | +[file an issue](https://github.com/perl6/whateverable/issues/new). |
| 20 | +Include as much information as you feel necessary. |
| 21 | + |
| 22 | +Note that issues are only closed once there is a fix *and* at least |
| 23 | +one test. Tickets that need tests are marked with |
| 24 | +[`testneeded`](https://github.com/perl6/whateverable/issues?q=is%3Aissue+is%3Aopen+label%3Atestneeded) |
| 25 | +label. |
| 26 | + |
| 27 | + |
| 28 | +### Submitting changes |
| 29 | + |
| 30 | +Generally, code contributions are accepted as |
| 31 | +[pull requests](https://help.github.com/articles/about-pull-requests/). |
| 32 | +Let us know if that is not suitable for you and you want to contribute |
| 33 | +in a different way (e.g. by mailing a patch). |
| 34 | + |
| 35 | +To test your changes, check out |
| 36 | +[wiki/Installation](https://github.com/perl6/whateverable/wiki/Installation) |
| 37 | +for instructions on installing and running the bots. |
| 38 | + |
| 39 | +Coding conventions are not enforced, but try to keep your changes |
| 40 | +consistent with code around them. For example, you'll find that |
| 41 | +unicode quotes (`“”`, `‘’`, `「」`) are preferred over ASCII quotes |
| 42 | +(`""`, `''`), but pull requests will be accepted regardless of which |
| 43 | +quotes are used. The code will be consistified later in bulk. |
| 44 | + |
| 45 | + |
| 46 | +### Do you want more information about the bots? |
| 47 | + |
| 48 | +If you want to learn more about the functionality of the bots, please |
| 49 | +see [whateverable wiki](https://github.com/perl6/whateverable/wiki). |
0 commit comments