Created by: dkarlovi
Summary
This is a set of tweaks to the generated documentation of the php generator, based on markdownlint and other similar tools packaged in my https://github.com/dkarlovi/docker-docqa Docker image.
The main README was slightly rearranged to make it more readable, moving the parts a package user would actually be interested in to the top.
See an example here https://github.com/flexolabs/reddit-client
PR checklist
-
Read the contribution guidelines. -
Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community. -
If contributing template-only or documentation-only changes which will change sample output, build the project beforehand. -
Run the shell script ./bin/generate-samples.shto update all Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master. These must match the expectations made by your contribution. You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example./bin/generate-samples.sh bin/configs/java*. For Windows users, please run the script in Git BASH. -
File the PR against the correct branch: master -
Copy the technical committee to review the pull request if your PR is targeting a particular programming language.
@jebentier (2017/07), @dkarlovi (2017/07), @mandrean (2017/08), @jfastnacht (2017/09), @ackintosh (2017/09) heart, @ybelenko (2018/07), @renepardon (2018/12)