Skip to content

Latest commit

 

History

History
52 lines (29 loc) · 2.54 KB

contributing-maui.md

File metadata and controls

52 lines (29 loc) · 2.54 KB
Raw

Contribute to the .NET MAUI Community Toolkit documentation

Thank you for your interest in contributing to the .NET MAUI Community Toolkit documentation.

Documentation is required when completing a proposal as part of our proposal workflow.

Starting your changes

You will need to fork this repository. We strongly recommend that you create a branch from your main branch so that it will reduce any complications when submitting your Pull Request.

Recommended tooling

We recommend that you use Visual Studio Code for the editing of documentation files along with the Docs Authoring Pack extension. This helps with validating code example formatting and also spell checking among other rules. For more information, see the Docs Authoring Pack documentation

Making your changes

This is where you get to add your content.

Adding a new file

Please make sure the following changes are made:

  • Include the new file in the TOC.yml file at the appropriate level (e.g. documentation pages for converters will go under the "Converters" name)
  • Include links to the new file in any markdown files that require it (e.g. documentation pages for converters will also require that a link is added to the converters/index.md file, the same should be true for all specific documentation pages)
  • Use the template file as a starting point
  • Follow the General rules section

Modifying a file

This should be simpler than adding a new file:

  • Follow the General rules section.

General rules

  • Always refer to the underlying technology as .NET MAUI and not just MAUI.

  • Code examples should follow the same guidelines as the toolkit and it's sample application.

  • Keep the code examples clear and concise, only try to show the concept to the user and not lots of extra code that makes it more difficult to follow the concept.

  • Links to Microsoft documentation pages should not include locale information and they should be relative. For example:

    https://learn.microsoft.com/dotnet/maui/

should be shortened to:

/dotnet/maui/

  • Try to use a spelling and grammar checker.

Submitting changes

Once you have completed your changes make sure you push them and open a Pull Request.