maker-bundle icon indicating copy to clipboard operation
maker-bundle copied to clipboard

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

Open smnandre opened this issue 11 months ago • 2 comments

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.)

smnandre avatar Dec 25 '24 18:12 smnandre

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 https://github.com/friendsoftwig/twigcs/issues/304#issue-1993173122

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.

VincentLanglet avatar Dec 25 '24 19:12 VincentLanglet

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 🤷

smnandre avatar Dec 25 '24 21:12 smnandre