|
2 | 2 |
|
3 | 3 | ## Issue tracker |
4 | 4 |
|
5 | | -Use it for bug reports, feature requests, and pull requests - but **not** for personal support (use [Discussions](https://github.com/YOURLS/YOURLS/discussions) instead). |
| 5 | +Use the issue tracker for bug reports, feature requests, and pull requests. |
| 6 | +Personal support must be discussed using [discussions space](https://github.com/orgs/YOURLS/discussions). |
6 | 7 |
|
7 | 8 | ## Bug reports |
8 | 9 |
|
9 | | -Before reporting: search existing issues (open and closed) and test against the latest `master`. A good report includes YOURLS/MySQL/PHP versions, expected vs actual output, and steps to reproduce the problem. |
| 10 | +Search existing issues (open and closed) before reporting. |
| 11 | +Ensure the alleged behavior is observed on the latest version. |
| 12 | +A good report includes YOURLS/MySQL/PHP versions, expected and actual behavior, and steps to reproduce the problem. |
10 | 13 |
|
11 | 14 | ## Feature requests |
12 | 15 |
|
13 | | -YOURLS aims to stay lean and cover the needs of the vast majority of users - if a feature wouldn't be useful to nearly everyone, it probably belongs in a plugin rather than core. The plugin architecture is specifically designed for that. |
| 16 | +YOURLS aims to stay lean and cover the needs of the vast majority of users. |
| 17 | +If a feature wouldn't be useful to nearly everyone, it probably belongs in a plugin rather than core. |
| 18 | +The [plugin architecture](https://yourls.org/docs/development/plugins) is designed to extend core behavior for the custom use cases. |
14 | 19 |
|
15 | 20 | Make sure your idea fits the project's scope, and provide context to make a strong case. |
16 | 21 |
|
17 | 22 | ## Pull requests |
18 | 23 |
|
19 | 24 | - It's better to ask before starting any significant work. |
20 | | -- Using AI ? Read our [AI_POLICY.md](AI_POLICY.md) |
21 | | -- Keep PRs focused - one concern per PR, and avoid unrelated changes such as whitespace fixes or rewording comments elsewhere in the codebase. |
| 25 | +- AI use must follow our [AI Policy](AI_POLICY.md). |
| 26 | +- Keep pull requests focused. |
| 27 | +- Limit pull requests to a single concern. |
| 28 | +- Avoid unrelated changes such as whitespace fixes or rewording comments elsewhere in the codebase. |
22 | 29 | - Follow existing coding conventions. |
23 | 30 | - Unit tests are very welcome. |
24 | 31 | - Your code will be licensed under the [MIT License](https://github.com/YOURLS/YOURLS/blob/master/LICENSE). |
25 | 32 |
|
26 | | -Standard flow: fork → branch off `master` → commit in logical chunks → push → open PR and fill the template. |
27 | 33 |
|
28 | | -## ❤️ Thank you ! |
| 34 | +❤️ Thank you ! |
0 commit comments