CONTRIBUTING.md File

[ruflin]

This pull request is to discuss content of the CONTRIBUTING.md file. The first contributions are only some nodes.

FYI: @im-denisenko @webdevsHub

[ruflin]

• I suggest to add that also "collaborators" should never merge their own pull request
• Links to Elastica.io must be provided on how to run docker-compose and builds

[im-denisenko]

A few thoughts.

For issues:

• Ask people to open an issue only for bug/feature request/change request and use SO/Gitter otherwise.
• Ask people to search in existing issues first
• Ask people to provide information how to reproduce their bug or what is feature they want.

For pull requests:

• Mention rule "one change per pull request"
• Mention that each commit should have meaning.
• Mention that squash trash commits is good.
• Mention that rebase from upstream after PR is ready to be merged is very good.
• Mention that every addition must have at least unit tests.
• Mention that every test must have group.
• Suggest to look through existing code to get point how to add new one.
• Encourage people to use feature branches for pull requests instead master.
• Mention semver and that BC breaks must be argumented.

[ruflin]

@im-denisenko I updated the file. I left out the parts with squashing commits and rebase. This can be dangerous especially for unexperienced users. So the experienced ones are going to do this anyways and know when to do it, but the less experience are going to "save" route. I added all the other points.

I suggest we merge this to have a first version available and update it from there. I would like to add some more "examples" on how to setup the project and run the tests.

@im-denisenko What is the current command you run to "cleanup" the code styles?

[im-denisenko]

@ruflin Looks good. I'm not sure how it looks for native speaker, but i'm not one who could fix this :)

For cs cleanup I use one of these:

vendor/bin/php-cs-fixer fix directory/filename.php
vendor/bin/php-cs-fixer fix directory/
vendor/bin/php-cs-fixer fix

[ruflin]

I tested it briefly and it looks like we used php-cs-fixer dir --level=psr2so far. If I call fix, it applies some more changes. I actually quite like the additional changes like making everything to single quotes.

[im-denisenko]

we used level psr2 so far

It was symfony level with 3 additional fixers, as defined here.
php-cs-fixer should get config from file with this name by default.

[ruflin]

Right, forgot about this one. It picks the config if no dir is defined as the dir is also in the config file. It removes all package comments and adds a dot at the end of all comments. This leads to changing almost all files. So either we haven't run it for a really long time or something in the "default" symfony config changed (which I assume is the case).

[webdevsHub]

Better:

"All changes must be documented in the CHANGELOG."

[ruflin]

@webdevsHub Thanks for the notes. I made the changes to the file.