From efd9e989c2cf081f55a9e62e6a41ea63bd867b2f Mon Sep 17 00:00:00 2001 From: Jonathan Dick Date: Mon, 12 Mar 2018 15:05:03 -0400 Subject: [PATCH] Updated CONTRIBUTING.md with mdoc information --- CONTRIBUTING.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1224dff..f2f7b11 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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).