Created by: ybelenko
PR checklist
-
Read the contribution guidelines. -
If contributing template-only or documentation-only changes which will change sample output, build the project before. -
Run the shell script(s) under ./bin/(or Windows batch scripts under.\bin\windows) to update Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit, and these must match the expectations made by your contribution. You only need to run./bin/{LANG}-petstore.sh,./bin/openapi3/{LANG}-petstore.shif updating the code or mustache templates for a language ({LANG}) (e.g. php, ruby, python, etc). -
File the PR against the correct branch: master,4.3.x,5.0.x. Default:master. -
Copy the technical committee to review the pull request if your PR is targeting a particular programming language.
I didn't add run of PHP_CodeSniffer(popular PHP linter) on purpose. I think that there will be code styling issues which cannot be solved automatically because of mustaches. For instance I had problems with multiline mustache values. If value contains line breaks and indentations I cannot align it with other parts of the script. PHP_CodeSniffer will always complain about wrong indentations, so integration test will be failed. Anyway, syntax check + unit tests gives 100% workable build, while code formatting may be not perfect.
Current integration test process:
- Composer dependencies install
- Full PHP syntax check by phplint package
- Tests run by PHPUnit.