-
Notifications
You must be signed in to change notification settings - Fork 775
Adhere to GitHub Community Standards #1625
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1625 +/- ##
=========================================
Coverage 97.93% 97.93%
Complexity 958 958
=========================================
Files 197 197
Lines 2228 2228
=========================================
Hits 2182 2182
Misses 46 46 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR improves the project's GitHub community standards compliance by adding standard GitHub community files and reorganizing existing documentation.
Changes:
- Moved CONTRIBUTING.md to .github/ folder and updated the reference in README.md
- Removed outdated CHANGELOG.md file
- Added GitHub community standard files: SECURITY.md, PULL_REQUEST_TEMPLATE.md, CODE_OF_CONDUCT.md, and issue templates
Reviewed changes
Copilot reviewed 8 out of 9 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| REUSE.toml | Updated copyright annotations to include new GitHub template files |
| README.md | Updated link to point to relocated CONTRIBUTING.md in .github/ folder |
| CHANGELOG.md | Removed outdated changelog file that was no longer maintained |
| .github/SECURITY.md | Added security policy with vulnerability reporting instructions |
| .github/PULL_REQUEST_TEMPLATE.md | Added minimalistic pull request template with type of change checklist |
| .github/ISSUE_TEMPLATES/feature_request.md | Added feature request issue template |
| .github/ISSUE_TEMPLATES/bug_report.md | Added bug report issue template |
| .github/CONTRIBUTING.md | Relocated contributing guidelines from root to .github/ folder |
| .github/CODE_OF_CONDUCT.md | Added minimalistic code of conduct |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
henriquemoody
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is an awesome change!
Most of those files can stay at the root of the repository and still adhere to GitHub's community standards. I was seeing that other projects also leave them at the root:
https://github.com/symfony/symfony
https://github.com/doctrine/orm
https://github.com/composer/composer/
|
I, personally, don't like these files very much. That's why I'm adding them to the As I mentioned in the commit description, my plan is to have a Do you prefer them in the root folder? I find that to add too much clutter, with UPPERCASED files that are too distracting. |
fcc3621 to
4bc60c3
Compare
|
Personally, I tend to look at the CONTRIBUTING.md file in repositories, and I think some AI agents also look for them. If you feel strongly about having all those files at the root, I can compromise with all of them, but I would really want to keep the CONTRIBUTING.md file in the root folder. |
4bc60c3 to
1262d54
Compare
|
I don't mid the uppercase files because LICENSE and README are also standard, and they're uppercase. More of the same to mee |
1262d54 to
dcd2084
Compare
|
@henriquemoody makes sense, I moved the |
Makes the project more friendly to GitHub users by providing conventional files. Those changes will improve our score under the GitHub community tab: https://github.com/Respect/Validation/community - The CHANGELOG.md file was removed. It was outdated and not being maintained. - Minimalistic .github/PULL_REQUEST_TEMPLATE.md - Minimalistic .github/SECURITY.md - Minimalistic .github/CODE_OF_CONDUCT.md - Minimalistic .github/ISSUE_TEMPLATE
|
You gotta edit your commit message, BTW |
dcd2084 to
b67bcb0
Compare
Makes the project more friendly to GitHub users by providing conventional files.
Those changes will improve our score under the GitHub community tab:
https://github.com/Respect/Validation/community
The CONTRIBUTING.md file was moved to the .github/ folder to remove clutter. This change is also in preparation to create more comprehensive developer documentation under a dedicated section indocs/