Skip to content

Commit bb0d0a3

Browse files
ozhLeoColomb
andauthored
Apply suggestions from code review
Co-authored-by: Léo Colombaro <LeoColomb@users.noreply.github.com>
1 parent 93188f6 commit bb0d0a3

2 files changed

Lines changed: 18 additions & 11 deletions

File tree

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
1-
Pre-requisites :
2-
- [ ] I have read CONTRIBUTING.md
3-
- [ ] I am using AI and have read AI_POLICY.md
1+
## Pre-requisites
42

3+
- [ ] I have read the [Contributing Guidelines](https://github.com/YOURLS/.github/blob/main/CONTRIBUTING.md)
4+
- [ ] I am using AI and have read the [AI Policy](https://github.com/YOURLS/.github/blob/main/AI_POLICY.md)
55

6-
## Description of your PR
6+
7+
## Change Description
78
<!--- Describe IN YOUR OWN WORDS your changes in detail. Why is this change required? What problem does it solve? --->
89

910

CONTRIBUTING.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,27 +2,33 @@
22

33
## Issue tracker
44

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).
67

78
## Bug reports
89

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.
1013

1114
## Feature requests
1215

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.
1419

1520
Make sure your idea fits the project's scope, and provide context to make a strong case.
1621

1722
## Pull requests
1823

1924
- 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.
2229
- Follow existing coding conventions.
2330
- Unit tests are very welcome.
2431
- Your code will be licensed under the [MIT License](https://github.com/YOURLS/YOURLS/blob/master/LICENSE).
2532

26-
Standard flow: fork → branch off `master` → commit in logical chunks → push → open PR and fill the template.
2733

28-
## ❤️ Thank you !
34+
❤️ Thank you !

0 commit comments

Comments
 (0)