Skip to content

Latest commit

 

History

History
199 lines (130 loc) · 10.3 KB

CONTRIBUTING.md

File metadata and controls

199 lines (130 loc) · 10.3 KB
Raw

Contribute to the ASP.NET Core documentation

This document covers the process for contributing to the articles and code samples that are hosted on the ASP.NET documentation site. Typo corrections and new articles are welcome contributions.

How to make a simple correction or suggestion

Articles are stored in the repository as Markdown files. Simple changes to the content of a Markdown file are made in the browser by selecting the Edit link in the upper-right corner of the browser window. (In a narrow browser window, expand the options bar to see the Edit link.) Follow the directions to create a pull request (PR). We will review the PR and accept it or suggest changes.

How to make a more complex submission

You need a basic understanding of Git and GitHub.com.

  • Open an issue describing what you want to do, such as changing an existing article or creating a new one. We often request an outline for a new topic suggestion. Wait for approval from the team before you invest much time.
  • Fork the aspnet/Docs repo and create a branch for your changes.
  • Submit a PR to the main branch with your changes.
  • If your PR has the label 'cla-required' assigned, complete the Contribution License Agreement (CLA).
  • Respond to PR feedback.

For an example where this process led to publication of a new article, see Issue 1477 and Pull Request 18955 in the .NET Docs repository. The new article is Use code coverage for unit testing.

Learn Authoring Pack extension in Visual Studio Code

If you use Visual Studio Code to contribute to the ASP.NET documentation, you can boost your productivity by installing the Learn Authoring Pack extension. The extension provides a variety of tools that helps with Markdown linting, code spell checking, and article templates.

Markdown syntax

Articles are written in DocFx-flavored Markdown, which is a superset of GitHub-flavored Markdown (GFM). For examples of DFM syntax for UI features commonly used in the ASP.NET documentation, see Metadata and Markdown template.

Folder structure conventions

For each Markdown file, a folder for images and a folder for sample code may exist. If the article is fundamentals/configuration/index.md, the images are in fundamentals/configuration/index/_static and the sample app project files are in fundamentals/configuration/index/sample. An image in the fundamentals/configuration/index.md file is rendered by the following Markdown:

![description of image for alt attribute](configuration/index/_static/imagename.png)

All images should have alternative (alt) text. For advice on specifying alt text, see online resources, such as WebAIM: Alternative Text.

Use lowercase for Markdown file names and image file names.

Internal links

Internal links should use the uid of the target article with an xref link (link text is set to the linked content's title):

<xref:uid_of_the_topic>

If the title of the article isn't intended for use in link text (for example, a word or phrase in a sentence is the link text), specify the xref link and link text with the following:

[link text](xref:uid_of_the_topic)

For more information, see the DocFX Cross Reference.

Images and screenshots

Don't include images with articles, except:

  • In basic onboarding (beginner) tutorials.
  • When an image is needed for clarity.

These restrictions reduce the size of the repository.

As an optional step, ensure that any images and screenshots used in the documentation are compressed, which helps with file size and page load performance. A few popular tools include TinyPNG (using the TinyPNG website or the TinyPNG API) or the Image Optimizer Visual Studio extension.

Code snippets

Articles frequently contain code snippets to illustrate points. DFM allows you to copy code into the Markdown file or refer to a separate code file. We prefer to use separate code files whenever possible to minimize the chance of errors in the code. The code files are stored in the repo using the folder structure described earlier for sample projects.

The following examples illustrate DFM code snippet syntax for use in a configuration/index.md file.

To render an entire code file as a snippet:

[!code-csharp[](configuration/index/sample/Program.cs)]

To render a portion of a file as a snippet by using line numbers:

[!code-csharp[](configuration/index/sample/Program.cs?range=1-10,20,30,40-50)]
[!code-html[](configuration/index/sample/Views/Home/Index.cshtml?range=1-10,20,30,40-50)]

For C# snippets, reference a C# region. Whenever possible, use regions rather than line numbers because line numbers in a code file tend to change and become out of sync with line number references in Markdown. C# regions can be nested. If referencing the outer region, the inner #region and #endregion directives aren't rendered in a snippet.

To render a C# region named "snippet_Example":

[!code-csharp[](configuration/index/sample/Program.cs?name=snippet_Example)]

To highlight selected lines in a rendered snippet (usually renders as yellow background color):

[!code-csharp[](configuration/index/sample/Program.cs?name=snippet_Example&highlight=1-3,10,20-25)]
[!code-csharp[](configuration/index/sample/Program.cs?range=10-20&highlight=1-3)]
[!code-html[](configuration/index/sample/Views/Home/Index.cshtml?range=10-20&highlight=1-3)]
[!code-javascript[](configuration/index/sample/UsingOptionsSample.csproj?range=10-20&highlight=1-3)]

When highlighting lines within regions, use line numbers (or a range of line numbers) relative to the snippet's #region directive, as seen in the following example.

The following partial C# code (Movie.cs) example includes a region named FinalSnippet with three using statements:

        ...
        public decimal Price { get; set; }
        public string? Rating {  get; set; }
    }
}
#endregion
#endif
#if Final
#region FinalSnippet
using System;
using System.ComponentModel.DataAnnotations;
using System.ComponentModel.DataAnnotations.Schema;

namespace MvcMovie.Models
{
    public class Movie
    {
        public int Id { get; set; }

        ...
    }
}
#endregion
#endif

To highlight the three using statements from the preceding example, specify a highlight property in the query string with a value of 1-3.

Markdown:

[!code-csharp[](sample/MvcMovie60/Models/Movie.cs?name=FinalSnippet&highlight=1-3)]

Test changes with DocFX

Test your changes with the DocFX command-line tool, which creates a locally hosted version of the site. DocFX doesn't render style and site extensions created for Microsoft Docs.

DocFX requires:

  • .NET Framework on Windows.
  • Mono for Linux or macOS.

Windows instructions

  • Download and unzip docfx.zip from DocFX releases.

  • Add DocFX to your PATH.

  • In a command shell, navigate to the folder that contains the docfx.json file (aspnet for ASP.NET content or aspnetcore for ASP.NET Core content) and run the following command:

    docfx --serve

  • In a browser, navigate to http://localhost:8080/group1-dest/.

Mono instructions

  • Install Mono via Homebrew:

    brew install mono

  • Download the latest version of DocFX.

  • Extract the archive to $HOME/bin/docfx.

  • Create a pair of aliases for docfx in a bash shell. The first alias is used to build the documentation. The second alias is used to build and serve the documentation.

    alias docfx='mono $HOME/bin/docfx/docfx.exe'
alias docfx-serve='mono $HOME/bin/docfx/docfx.exe --serve'

  • In a command shell, navigate to the folder that contains the docfx.json file (aspnet for ASP.NET content or aspnetcore for ASP.NET Core content) and run the following command to build and serve the docs via its alias:

    docfx-serve

  • In a browser, navigate to http://localhost:8080/group1-dest/.

Voice and tone

Our goal is to write documentation that is easily understandable by the widest possible audience. To that end, we established guidelines for writing style that we ask our contributors to follow. For more information, see Voice and tone guidelines in the .NET repo.

Microsoft Writing Style Guide

The Microsoft Writing Style Guide provides writing style and terminology guidance for all forms of technology communication, including the ASP.NET Core documentation.

Redirects

If you delete an article, change its file name, or move it to a different folder, create a redirect so that people who bookmarked the article don't receive a 404 Not Found error. Add redirects to the main redirect file.