Skip to content

Latest commit

 

History

History
56 lines (33 loc) · 3.04 KB

CONTRIBUTING.md

File metadata and controls

56 lines (33 loc) · 3.04 KB
Raw

Contributing to Windows Driver Reference Documentation

This page covers the basic steps for contributing to the Windows driver reference documentation.

Architecture

The reference docs are generated by merging the syntax block from Windows headers with descriptions and remarks stored in the *.md files in this repo. Because the API surface (signature, requirements) is auto-generated, changes to the following sections will be discarded:

*  Headings
*  Syntax tokens
*  Requirements
*  YAML block

Sign a CLA

If you want to contribute more than a couple lines and you're not a Microsoft employee, you need to sign a Microsoft Contribution Licensing Agreement (CLA).

If you are a Microsoft employee, be sure to link your GitHub account and alias.

If you've already contributed to Microsoft repositories in the past, congratulations! You've already completed this step.

Proposing a change

If you'd like to suggest a change to the docs, follow these steps:

  1. If you're viewing a Docs.microsoft.com page, click the Edit button in the upper right of the page. You will be redirected to the corresponding Markdown source file in the GitHub repository. If you're already in the GitHub repo, you can just navigate to the source file you would like to change.
  2. If you don't already have a GitHub account, click Sign Up in the upper right and create a new account.
  3. From the GitHub page you would like to change, click the pencil icon.
  4. Modify the file and use the preview tab to ensure the changes look good.
  5. When you're done, commit your changes and open a pull request.

After you create the pull request, a member of the Windows Driver Documentation team will review your changes.

If your request is accepted, updates are published to https://docs.microsoft.com/windows-hardware/drivers/ddi, usually within 24 hours.

If you're a Microsoft employee and you need to collaborate in a private environment, please contact the windowsdriverdev alias.

Making more substantial changes

To make substantial changes to an existing article, add or change images, or contribute a new article, we recommend forking the official repo into your GitHub account, and then creating a local clone.

For more info, see Fork a Repo.

Using issues to provide feedback on Windows driver documentation

If you would like to provide feedback rather than suggesting a change to documentation, create an issue.

Be sure to include the topic title and the URL for the page.

Resources

You can use your favorite text editor to edit Markdown. We recommend Visual Studio Code, a free lightweight open source editor from Microsoft.

You can learn the basics of Markdown in just a few minutes. To get started, check out Mastering Markdown.