Updated CONTRIBUTING.md with mdoc information

This commit is contained in:
Jonathan Dick 2018-03-12 15:05:03 -04:00 коммит произвёл GitHub
Родитель 725c25604f
Коммит efd9e989c2
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
1 изменённых файлов: 9 добавлений и 0 удалений

Просмотреть файл

@ -14,6 +14,15 @@ You will need to complete a Contribution License Agreement before any pull reque
Check out [A Beginner's Guide for Contributing to Microsoft Caboodle](https://github.com/xamarin/Caboodle/wiki/A-Beginner's-Guide-for-Contributing-to-Microsoft-Caboodle).
## Documentation - mdoc
This project uses [mdoc](http://www.mono-project.com/docs/tools+libraries/tools/monodoc/generating-documentation/) to document types, members, and to add small code snippets and examples. mdoc files are simple xml files and there is an msbuild target you can invoke to help generate the xml placeholders.
Read the [Documenting your code with mdoc wiki page](wiki/Documenting-your-code-with-mdoc) for more information on this process.
Every pull request which affects public types or members should include corresponding mdoc xml file changes.
### Bug Fixes
If you're looking for something to fix, please browse [open issues](https://github.com/xamarin/Caboodle/issues).