Contributing to SharePointDsc
If you are keen to make SharePointDsc better, why not consider contributing your work to the project? Every little change helps us make a better resource for everyone to use, and we would love to have contributions from the community.
We follow all of the standard contribution guidelines for DSC resources outlined in DscResources repo, so please review these as a baseline for contributing.
With over 70 resources in our module, we want to keep the documentation work light. To aid this, we are generating our documentation dynamically. Therefore for each DSC resource we have, the following items must be completed so we can generate these.
- in the folder for the resource place a readme.md file that contains heading 'Description' and a text description of the module
- in the schema.mof file for the resource ensure that there are description attributes on all properties
- generate examples for the resource in the Examples/resources/[resource name] folder, using PowerShell help syntax to describe the example at the top of the file. These should be a complete configuration that can run, the configuration must be called "example" and it must only take parameters of PSCredential types. This will allow our unit tests to validate the examples as part of our build process
With these items in place, we can dynamically generate the help files for PowerShell as well as this wiki if these items are completed.
SharePointDsc is designed to work correctly against both the 2013 and 2016 versions of the product. The automated unit tests that are run in SharePointDsc will automatically execute against both versions of the product using the stub modules we include in the unit tests directory.
Where a resource applies to only a specific version (such as xSPUserProfileSyncService) the code should throw meaningful errors to indicate that it should not be used with the installed version of the product.
