beenull/Pico
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update CONTRIBUTING.md

Browse source 
Add "Keep documentation in sync" section
This commit is contained in:
Daniel Rudolf 2015-11-02 23:43:40 +01:00
parent 85d7c510f9
commit 0e0eb567fa
1 changed files with 6 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
CONTRIBUTING.md
View file

@ -43,6 +43,12 @@ It is recommended to check your code using [PHP_CodeSniffer](https://github.com/
With this command you can specify a file or folder to limit which files it will check or omit that argument altogether, in which case the current directory is checked.
### Keep documentation in sync
Pico accepts the problems of having redundant documentation on different places (concretely Picos inline user docs, the `README.md` and the website) for the sake of a better user experience. When updating the docs, please make sure the keep them in sync.
If you update the [`README.md`](https://github.com/picocms/Pico/blob/master/README.md) or [`content-sample/index.md`](https://github.com/picocms/Pico/blob/master/content-sample/index.md), please make sure to update the corresponding files in the [`_docs`](https://github.com/picocms/Pico/tree/gh-pages/_docs/) folder of the `gh-pages` branch (i.e. [Picos website](http://picocms.org/docs.html)) and vice verca. Unfortunately this involves three (!) different markdown parsers. If you're experiencing problems, use Picos [`erusev/parsedown-extra`](https://github.com/erusev/parsedown-extra) as a reference. You can try to make the contents compatible to [Redcarpet](https://github.com/vmg/redcarpet) by yourself, otherwise please address the issues in your pull request message and we'll take care of it.
Versioning
----------