Skip to content

Commit

Permalink
docs: Add information about allowing maintainers to update PRs (#7683)
Browse files Browse the repository at this point in the history
Co-authored-by: Julien Falque <julien.falque@gmail.com>
  • Loading branch information
Wirone and julienfalque committed Jan 6, 2024
1 parent 167eb6c commit 3a531ba
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,10 @@ A *config* knows about the code style rules and the files and directories that m

## How to contribute

ℹ️ **IMPORTANT**: before contributing with really significant changes that require a lot of effort or are crucial from this tool's architecture perspective, please open [RFC on GitHub Discussion](https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/discussions/categories/rfc). The development effort should start only after the proposal is discussed and the approach aligned.
> [!IMPORTANT]
> Before contributing with _really_ significant changes that require a lot of effort or are crucial from this tool's
> architecture perspective, please open [RFC on GitHub Discussion](https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/discussions/categories/rfc).
> The development effort should start only after the proposal is discussed and the approach aligned.
### Development

Expand All @@ -43,6 +46,13 @@ You can do some things to increase the chance that your pull request is accepted
* Remember about tests and documentation.
* Don't bump `PhpCsFixer\Console\Application::VERSION`, it's done during release.

> [!IMPORTANT]
> Your pull request will have much higher chance of getting merged if you allow maintainers to push changes to your
> branch. You can do it by ticking "Allow edits and access to secrets by maintainers" checkbox, but please keep in mind
> this option is available only if your PR is created from a user's fork. If your fork is a part of organisation, then
> you can add [Fixer maintainers](https://github.com/orgs/PHP-CS-Fixer/people) as members of that repository. This way
> maintainers will be able to provide required changes or rebase your branch (only up-to-date PRs can be merged).
## Working With Docker

This project provides a Docker setup that allows working on it using any of the PHP versions supported by the tool.
Expand Down

0 comments on commit 3a531ba

Please sign in to comment.