diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 70313ab..527005d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,16 +8,16 @@ By participating in this project, you agree to abide by the [Code of Conduct](CO **Requirements:** -- PHP 8.1 or higher. +- PHP 8.3 or higher. - [Composer](https://getcomposer.org/) 2.x. **Setup:** ```bash -git clone https://github.com/php-forge/.git -cd +git clone https://github.com/php-forge/.git +cd composer install -composer test +composer run ``` ## Coding Standards @@ -31,12 +31,13 @@ All PHP code must follow these standards: ## Testing -- All tests use **PHPUnit 10+**. +- All tests use **PHPUnit 12+**. - Target **100% code coverage** for new code. -- Run the test suite before submitting a pull request: +- Run the quality/test scripts defined in the target repository's `composer.json` before submitting a pull request + (for example, `test`, `static`, `ecs`, `rector`, or `check-dependencies`): ```bash -composer test +composer run ``` ## Pull Request Process @@ -48,11 +49,6 @@ composer test 5. Ensure all tests pass and coding standards are met. 6. Open a pull request against `main` with a clear description of the change. -## Bug Reports and Feature Requests - -- **Bug reports**: Use the [Bug Report](https://github.com/php-forge/.github/issues/new?template=bug-report.yml) template. -- **Feature requests**: Use the [Feature Request](https://github.com/php-forge/.github/issues/new?template=feature-request.yml) template. - ## Security Vulnerabilities Do not open public issues for security vulnerabilities. See [SECURITY.md](SECURITY.md) for reporting instructions. diff --git a/SECURITY.md b/SECURITY.md index 1e3d7f4..b25add4 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -6,7 +6,8 @@ Use the GitHub Security Advisories feature in the affected repository to report vulnerabilities privately: -1. Navigate to the affected repository (e.g., `https://github.com/php-forge/`). +1. Navigate to the affected repository (for example, `https://github.com/yii2-extensions/repository`, replacing `repository` + with the affected repository). 2. Go to the **Security** tab. 3. Click **Report a vulnerability**. 4. Provide a detailed description including steps to reproduce, impact, and any suggested fix. @@ -25,4 +26,4 @@ Security fixes are applied to the latest release of each package. Older versions ## Scope -This policy applies to all repositories under the [php-forge](https://github.com/php-forge) organization. +This policy applies to all repositories under the [PHP Forge](https://github.com/php-forge) organization. diff --git a/SUPPORT.md b/SUPPORT.md deleted file mode 100644 index 15c56f6..0000000 --- a/SUPPORT.md +++ /dev/null @@ -1,20 +0,0 @@ -# Support - -## Getting Help - -- **Bug reports**: [Open a bug report](https://github.com/php-forge/.github/issues/new?template=bug-report.yml). -- **Feature requests**: [Open a feature request](https://github.com/php-forge/.github/issues/new?template=feature-request.yml). -- **Security vulnerabilities**: See [SECURITY.md](SECURITY.md). Do not open public issues. - -## Package Documentation - -| Package | Repository | -| --------------- | ------------------------------------------------------------------------- | -| coding-standard | [php-forge/coding-standard](https://github.com/php-forge/coding-standard) | -| foxy | [php-forge/foxy](https://github.com/php-forge/foxy) | -| helper | [php-forge/helper](https://github.com/php-forge/helper) | -| support | [php-forge/support](https://github.com/php-forge/support) | - -## Commercial Support - -For commercial support inquiries, consider [sponsoring the project](https://github.com/sponsors/terabytesoftw).