Skip to content

Polish contributing guide wording #1776

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.

Sign up for GitHub

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

Merged
alganet merged 1 commit into from
Jun 8, 2026
Merged

Polish contributing guide wording #1776

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Before writing anything, feature or bug fix:

## Adding a new validator

A common validator on Respect\Validation is composed of three classes:
A common validator on Respect\Validation is composed of two files:

- `src/Validators/YourValidatorName.php`: the validator itself
- `tests/unit/Validators/YourValidatorNameTest.php`: tests for the validator
Expand Down Expand Up @@ -76,9 +76,9 @@ final readonly class HelloWorld extends Simple

### Creating unit tests

Finally, we need to test if everything is running smooth. We have `RuleTestCase`
that allows us to make easier to test validators, but you fell free to use the
`PHPUnit\Framework\TestCase` if you want or you need it's necessary.
Finally, we need to test if everything is running smoothly. We have `RuleTestCase`
that makes it easier to test validators, but feel free to use
`PHPUnit\Framework\TestCase` if you want or if you need it.

The `RuleTestCase` extends PHPUnit's `PHPUnit\Framework\TestCase` class with
conventional [data provider][] methods:
Expand Down Expand Up @@ -130,9 +130,9 @@ for it other than what is covered by `RuleTestCase`.

### Helping us a little bit more

You should include documentation to your new validator. A minimal document
You should include documentation for your new validator. A minimal document
is acceptable. You can use `bin/console lint:docs` to help you ensure that
document follows our conventions. `bin/console lint:docs --fix` will even
the document follows our conventions. `bin/console lint:docs --fix` will even
fix some common mistakes automatically.

Additionally, consider adding a feature test to `tests/feature`. Those help
Expand All @@ -147,7 +147,7 @@ You can preview how the docs will look like by running `composer docs-serve`.

## Running Checks

After run `composer install` on the library's root directory you must run
After running `composer install` in the library's root directory you must run
`composer qa`.

This alias will run several checks, including unit tests, static analysis
Expand Down
Loading