mirror/intervention_image
1
0
Fork 0
mirror of https://github.com/Intervention/image.git synced 2025-08-26 07:14:31 +02:00
Code Issues Releases Wiki Activity

Externalize contribution guide

Browse Source
This commit is contained in:
Oliver Vogel
2025-06-15 08:52:29 +02:00
parent 9c77d8f2a4
commit a1e382ec49
1 changed files with 2 additions and 77 deletions
Download Patch File Download Diff File Expand all files Collapse all files

79
CONTRIBUTING.md
View File

@@ -1,80 +1,5 @@
# Contributing to Intervention Image # Contributing to Intervention Image
Thank you for your interest in contributing to the project. Any contribution Thank you for your interest in contributing to the project.
that improves the project is welcome and will be considered for integration.
Please understand that there is no guarantee that your pull request will be You can read the full contribution guide on https://intervention.io/contributing/.
accepted. To avoid misunderstandings, it is recommended that you first initiate
a discussion about your planned changes on the [issue
board](https://github.com/Intervention/image/issues).
You agree that your contributions will be licensed under the same license as
the main project. Before submitting a pull request familiarize yourself with
the [license](LICENSE) and understand its terms and conditions.
## Requirements
To ensure a smooth collaboration process and maintain the quality of the
project the submitted pull request must meet the following requirements to be
accepted for review. It is a good idea to check these locally **before** you
submit the PR.
### Follow the Branching Model
Please submit only one feature or bug fix per pull request. The best practice
is to split your contributions into thematically meaningful branches and then
submit them individually as pull requests.
### Comply with the Coding Standard
The project follows the [PSR12 coding
standard](https://www.php-fig.org/psr/psr-12/) with some [additional
extensions](phpcs.xml.dist). Adherence to these rules is essential and can be
easily checked with the following command.
```bash
./vendor/bin/phpcs
```
Or by using the project's Docker environment.
```bash
docker compose run --rm --build standards
```
### Write Tests
For new features or changes to the existing code base, it is essential to cover
them with tests. Integrate your tests in the the project's test environment
and consider both positive and negative scenarios.
Make sure that all tests are passed with the following command.
```bash
./vendor/bin/phpunit
```
Or by using the project's Docker environment.
```bash
docker compose run --rm --build tests
```
### Pay attention to the Analyzer Results
A static analyzer is also used to avoid bugs and ensure quality. In addition to
testing, it must also run without errors.
Check the analyzer by running the following command.
```bash
./vendor/bin/phpstan analyze --memory-limit=512M ./src
```
Or by using the project's Docker environment.
```bash
docker compose run --rm --build analysis
```
**Thank you!**