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.
In the resources provided by SharePointDsc, we include additional documentation as comments inside the schema mof files (this example from SPCreateFarm demonstrates this). This is then used along with the description and other metadata properties in the schema to dynamically generate our wiki page content as well as the help inside the PowerShell module. Any changes that add or modify a DSC resource schema should ensure the schema has the following:
- A commented section directly above the schema it described that uses markdown formatting to include a description and an example of how this resource is used
- Description properties on all properties that explain what the property does
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.
