Skip to content

Correct capitalization and punctuation in guidelines #118

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

Open
tacman wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Correct capitalization and punctuation in guidelines #118

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
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -288,10 +288,10 @@ Add your own Fixer / Contribute a Fixer

### Contribution guidelines

- You MUST write code in english;
- you MUST follow PSR2 and Symfony coding standard (run `composer cs` on your branch);
- you MUST run the tests (run `composer test`);
- you MUST comply to the MIT license;
- You MUST write code in English.
Copy link
Member

@lyrixx lyrixx Nov 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why did you change the ; to a .?
We always learn we should use ; 🤔

For example, on symfony.com, the use the same pattern!

Copy link
Author

@tacman tacman Nov 5, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is what claude tells me:

Most modern writing style guides (AP, Chicago Manual of Style for web content, etc.) recommend either:

No punctuation after bullets if they're phrases
Periods if they're complete sentences
Consistent punctuation throughout the list

The semicolon approach is becoming less common except in very formal or legal contexts.

To my eye, the ; looks odd, and in particular with the last bullet ending in a period.

- you MUST follow PSR2 and Symfony coding standard (run `composer cs` on your branch).
- you MUST run the tests (run `composer test`).
- you MUST comply with the MIT license.
- you SHOULD write documentation.

If you add a new Fixer, please provide sources and references about the typographic rule you want to fix.
Expand Down