Update CONTRIBUTING.md, SECURITY.md and remove SUPPORT.md.#4
Update CONTRIBUTING.md, SECURITY.md and remove SUPPORT.md.#4terabytesoftw merged 2 commits intomainfrom
CONTRIBUTING.md, SECURITY.md and remove SUPPORT.md.#4Conversation
|
Warning Rate limit exceeded
To continue reviewing without waiting, purchase usage credits in the billing tab. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📝 WalkthroughWalkthroughThis PR updates three key repository documentation files. CONTRIBUTING.md bumps the PHP version requirement to 8.3+, updates setup procedures to use composer install/run, and removes a bug reporting section. SECURITY.md clarifies vulnerability reporting with placeholder guidance. SUPPORT.md is deleted entirely. ChangesDocumentation & Guidelines Update
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested labels
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@CONTRIBUTING.md`:
- Line 20: Replace the ambiguous example "composer run" in CONTRIBUTING.md with
explicit script invocations so contributors can actually run checks — e.g.,
change "composer run" to "composer run test" (or list multiple examples like
"composer run static" / "composer run ecs" as appropriate) and add a short note
showing how to discover available scripts (e.g., "composer run-script --list" or
"composer run --list") so readers know how to find which script names to use.
In `@SECURITY.md`:
- Around line 9-10: Replace the inconsistent placeholder "repo-name" in
SECURITY.md with the unified placeholder "<repository>" used in CONTRIBUTING.md;
update the example URL and surrounding text so it reads
"https://github.com/php-forge/<repository>" (keeping the angle-bracket
placeholder style) to ensure consistent placeholder formatting across docs.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: ae5621e5-9865-407a-92da-3c224c3f8d03
📒 Files selected for processing (3)
CONTRIBUTING.mdSECURITY.mdSUPPORT.md
💤 Files with no reviewable changes (1)
- SUPPORT.md
📜 Review details
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: linter / Super Linter
|
@codex review |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 2a72e2afbd
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| 1. Navigate to the affected repository (for example, `https://github.com/yii2-extensions/repository`, replacing `repository` | ||
| with the affected repository). |
There was a problem hiding this comment.
Point security reporters at the PHP Forge org
This example URL now sends reporters to yii2-extensions/repository, but the policy scope below is PHP Forge and affected packages live under php-forge. For someone following these steps during a vulnerability report, replacing only repository still leaves them in the wrong organization, so they will not reach the affected repository's Security tab.
Useful? React with 👍 / 👎.
| cd <repository> | ||
| composer install | ||
| composer test | ||
| composer run |
There was a problem hiding this comment.
Specify a Composer script to run
composer run without a script is not a valid command in a package: I checked Composer 2.9.3 locally and it exits with Missing required argument "script", and the official run-script / run docs say to give it the script name. As written, both this setup command and the repeated Testing example tell contributors to run a command that fails instead of running the repository's quality checks.
Useful? React with 👍 / 👎.
Pull Request