Skip to content
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.

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

[DX] Add a CONTRIBUTING.md + Switch to Twig-Cs-Fixer ? #1632

Open
smnandre opened this issue Dec 25, 2024 · 2 comments
Open

[DX] Add a CONTRIBUTING.md + Switch to Twig-Cs-Fixer ? #1632

smnandre opened this issue Dec 25, 2024 · 2 comments

Comments

@smnandre
Copy link
Member

I’m thinking that some documentation could help contributors here (perhaps I missed it).

Especially regarding the tools used in the CI that we don’t often see in Symfony repositories, such as PHPStan and TwigCS. Again, I may have missed something, but the Composer scripts do not seem to be designed with contributors in mind.

Maybe a simple “How to Contribute” section in the documentation or a dedicated CONTRIBUTING.md file would be beneficial?

Additionally, what about removing TwigCS and starting to use Twig-CS-Fixer by @VincentLanglet, which attentively follows all Twig changes and best practices TwigCS is officially EOL and, to my knowledge, has only added minimal support for new PHP releases in the last two years.

(These are just personal comments based on my experience this afternoon. Feel free to close this if I’m out of bounds.)

@VincentLanglet
Copy link

Additionally, what about removing TwigCS and starting to use Twig-CS-Fixer by @VincentLanglet, which attentively follows all Twig changes and best practices TwigCS is officially EOL and, to my knowledge, has only added minimal support for new PHP releases in the last two years.

TwigCS still have some activity but indeed there is an open issue about his uncertain futur friendsoftwig/twigcs#304 (comment)

But since Twig-CS-Fixer is already quoted in https://twig.symfony.com/doc/3.x/coding_standards.html#coding-standards, it might make sens to use it.

@smnandre
Copy link
Member Author

TwigCS still have some activity

Well.. except compatibility for PHP version and minor CI changes, i don't see a PR merged since may 2022. It may "come back to like", but i fear recent (and incoming) changes in Twig won't be implemented 🤷

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants