Adding CONTRIBUTING.md

[TavoNiievez]

Co-authored by: @ThomasLandauer

[ThomasLandauer]

https://github.com/Codeception/symfony-module-tests/blob/main/README.md is perfect now - I like it! :-)

I couldn't find a way to edit CONTRIBUTING.md :-( Could you merge it so I can send PR's?

[TavoNiievez]

you can send a PR to my fork https://github.com/TavoNiievez/module-symfony/blob/contributing/CONTRIBUTING.md . The changes will be reflected here

[ThomasLandauer]

Great - see https://github.com/TavoNiievez/module-symfony/pull/1 :-)

[ThomasLandauer]

I forgot what https://github.com/Codeception/symfony-module-tests/blob/main/README.md contains ;-) Now step 1 overlaps with it. Suggestion:

• Can we move the "fork" part to https://github.com/Codeception/symfony-module-tests/blob/main/README.md ? I assume that forking it is always a good idea, isn't it?
  Then step 1 would become branch and the 3 steps from Adding some typehint #84 (comment)

Where can I send PR's to CONTRIBUTE.md now?

[TavoNiievez]

You won't always use Codeception/symfony-module-tests to make changes or submit PR, it may just be to explore how some method works in a simpler project or another Symfony version. (that's why some of these projects were also called 'demo').

Where can I send PR's to CONTRIBUTE.md now?

In the same place.

[ThomasLandauer]

Regarding Codeception/symfony-module-tests#5 :

• I'm guessing that git pull and git rebase don't do any harm, even if the fork is fresh anyway?
• If you agree in principle with this way, then I'll adapt (i.e. simplify) step 1 at https://github.com/TavoNiievez/module-symfony/blob/contributing/CONTRIBUTING.md accordingly.

[TavoNiievez]

OK, the only line that should be added to symfony-module-tests is:

'If you are using this project to create a Pull Request to the Symfony Module (see `CONTRIBUTING.md`):'

The git pull git rebase process is just a special case where you've forked a long time ago and the project has been updated since then. It should be just a very small note and should be in the contribution guides and not in the test project README.md.

[ThomasLandauer]

See #85 and sorry for the bad title ;-)

• General: It got a little more complicated now ("Continue with step 2+3..."). But what I suggested before (changing README.md) was equally confusing ;-)
• About git pull and rebase: Explaining in detail when this is needed and when not, is more complicated than just leaving it in. Main argument: Those who know what they are doing, won't paste those two lines anyway ;-) And for the others it doesn't do any harm.
• Please update git push --set-upstream origin new_feature. Due to git remote add upstream... you can probably remove something from it.

[TavoNiievez]

@ThomasLandauer I think the current state of the file is pretty good.

Unless there is something that is really wrong i think we can leave it as it is now so as not to overthink things.

[ThomasLandauer]

@TavoNiievez

1. Should CONTRIBUTING.md be mentioned at https://codeception.com/docs/modules/Symfony too?

2. And what is https://codeception.com/docs/modules/Symfony#Demo-Project ?

[TavoNiievez]

@ThomasLandauer

I do not update the Codeception page, the link to the test/demo project has already been updated.

btw, thanks again for helping with this.