|
1 | | -# Issue Guidelines |
| 1 | +# Issue guidelines |
2 | 2 |
|
3 | 3 | ## Reporting bugs |
4 | 4 |
|
5 | | -If you found a bug, report an issue and describe what's the expected behavior versus what actually happens. If the bug causes a crash, attach a full backtrace. If possible, a reproduction script showing the problem is highly appreciated. |
| 5 | +If you’ve found a bug, please report an issue and describe the expected behavior versus what actually happens. If the bug causes a crash, attach a full backtrace. If possible, a reproduction script showing the problem is highly appreciated. |
6 | 6 |
|
7 | 7 | ## Reporting feature requests |
8 | 8 |
|
9 | | -Report a feature request **only after discussing it first on [discourse.dry-rb.org](https://discourse.dry-rb.org)** where it was accepted. Please provide a concise description of the feature. |
| 9 | +Report a feature request **only after discussing it first on [our forum](https://discourse.hanamirb.org)** and having it accepted. Please provide a concise description of the feature. |
10 | 10 |
|
11 | 11 | ## Reporting questions, support requests, ideas, concerns etc. |
12 | 12 |
|
13 | | -**PLEASE DON'T** - use [discourse.dry-rb.org](https://discourse.dry-rb.org) instead. |
| 13 | +**Please don’t.** Use [our forum](https://discourse.hanamirb.org) instead. |
14 | 14 |
|
15 | | -# Pull Request Guidelines |
| 15 | +# Pull request guidelines |
16 | 16 |
|
17 | | -A Pull Request will only be accepted if it addresses a specific issue that was reported previously, or fixes typos, mistakes in documentation etc. |
| 17 | +A pull request will only be accepted if it addresses a specific issue that was reported previously, or fixes typos, mistakes in documentation etc. |
18 | 18 |
|
19 | 19 | Other requirements: |
20 | 20 |
|
21 | | -1) Do not open a pull request if you can't provide tests along with it. If you have problems writing tests, ask for help in the related issue. |
22 | | -2) Follow the style conventions of the surrounding code. In most cases, this is standard ruby style. |
23 | | -3) Add API documentation if it's a new feature |
24 | | -4) Update API documentation if it changes an existing feature |
25 | | -5) Bonus points for sending a PR which updates user documentation in the `docsite` directory |
| 21 | +1. Do not open a pull request if you can't provide tests along with it. If you have problems writing tests, ask for help in the related issue. |
| 22 | +2. Follow the style conventions of the surrounding code. In most cases, this is standard ruby style. |
| 23 | +3. Add API documentation if it's a new feature. |
| 24 | +4. Update API documentation if it changes an existing feature. |
| 25 | +5. Bonus points for sending a PR which updates user documentation in our [site repository](https://github.com/hanakai-rb/site). |
26 | 26 |
|
27 | 27 | # Asking for help |
28 | 28 |
|
29 | | -If these guidelines aren't helpful, and you're stuck, please post a message on [discourse.dry-rb.org](https://discourse.dry-rb.org). |
| 29 | +If these guidelines aren't helpful, and you're stuck, please post a message on [our forum](https://discourse.dry-rb.org) or [find us in chat](https://discord.gg/KFCxDmk3JQ). |
0 commit comments