Add contribution guidelines and project overview #124
Conversation
Change wording in most parts. Make reporting a bug section a list of bullet points. Rewrite the setup section to be simpler. Split validating and rendering the documentation into their own sections. Add an additional information section with links to pages that have information that was not included on this page.
CONTRIBUTING_DOCS.md
Outdated
| - [Brazilian Portugues](https://github.com/php/doc-pt_br) (doc-pt_br) | ||
| - [Chinese(Simplified)](https://github.com/php/doc-zh) (doc-zh) | ||
| - [English](https://github.com/php/doc-en) (doc-en) | ||
| - [French](https://github.com/php/doc-fr) (doc-fr) | ||
| - [German](https://github.com/php/doc-de) (doc-de) | ||
| - [Italian](https://github.com/php/doc-it) (doc-it) | ||
| - [Japanese](https://github.com/php/doc-ja) (doc-ja) | ||
| - [Russian](https://github.com/php/doc-ru) (doc-ru) | ||
| - [Spanish](https://github.com/php/doc-es) (doc-es) | ||
| - [Turkish](https://github.com/php/doc-tr) (doc-tr) |
There was a problem hiding this comment.
I deliberately didn't add languages/repositories that aren't available through php.net (Polish, Romanian and Ukrainian) but since there is a repo for each of these it could kind of make sense to add them. I leave the decision up to you. :-)
There was a problem hiding this comment.
I think it makes sense to add them, the Polish one is being active again and builds, Ukrainian has a maintainer, Romanian is the only one that is in limbo AFAIK.
There was a problem hiding this comment.
I've added all three of them.
| you can file a bug report by doing the following: | ||
|
|
||
| - click the "Report a Bug" link in the "Improve This Page" section | ||
| on the bottom of the page |
There was a problem hiding this comment.
nit: Can you indent all the lines properly? There are several with either 0 or 1 for the continuing line for bullets.
There was a problem hiding this comment.
I've updated all the indentation to make it more consistent and went with 1 space for lines continuing a bullet point.
This PR would add two files:
doc-*,doc-base,PhDandweb-php) and what they doThe latter file could be improved over time and linked to from the documentation repos and the "Learn How To Improve This Page" link on the documentations' pages.