Skip to content

Latest commit

 

History

History
62 lines (36 loc) · 3.7 KB

CONTRIBUTING.md

File metadata and controls

62 lines (36 loc) · 3.7 KB
Raw

Contributing

Thank you for your interest in contributing to the Windows Sysinternals documentation!

In this topic, you'll see the basic process for adding or updating content in the Windows Sysinternals documentation site.

In this topic, we'll cover:

Process for contributing

Step 1: Fork the MicrosoftDocs/sysinternals repo.

Step 3: Create a branch for your article.

Step 4: Make your update.

Step 5: Submit a Pull Request (PR) from your branch to MicrosoftDocs/sysinternals/main.

If your PR is addressing an existing issue, add the Fixes #Issue_Number keyword to the commit message or PR description, so the issue can be automatically closed when the PR is merged. For more information, see Closing issues via commit messages.

The Windows Sysinternals team will review your PR and let you know if the change looks good or if there are any other updates/changes necessary in order to approve it.

Step 6: Make any necessary updates to your branch as discussed with the team.

The maintainers will merge your PR into the master branch once feedback has been applied and your change looks good.

On a certain cadence, we push all commits from master branch into the live branch and then you'll be able to see your contribution live at Sysinternals.

DOs and DON'Ts

Below is a short list of guiding rules that you should keep in mind when you are contributing to the Windows Sysinternals documentation.

  • DON'T surprise us with big pull requests. Instead, file an issue and start a discussion so we can agree on a direction before you invest a large amount of time.
  • DO create a separate branch on your fork before working on the articles.
  • DO follow the GitHub Flow workflow.
  • DO blog and tweet (or whatever) about your contributions, frequently!

Building the docs

The documentation is written in GitHub Flavored Markdown and built using DocFX and other internal publishing/building tools. It's published at .NET documentation.

If you want to build the docs locally, you need to install DocFX; latest versions are the best.

There are several ways to use DocFX, and most of them are covered in the DocFX getting started guide. The following instructions use the command-line based version of the tool. If you are comfortable with other ways listed on the link above, feel free to use those.

Note: Currently DocFX requires the .NET Framework on Windows or Mono (for Linux or macOS). We hope to port it to .NET Core in the future.

You can build and preview the resulting site locally using a built-in web server. Navigate to the core-docs folder on your machine and type the following command:

docfx -t default --serve

This starts the local preview on localhost:8080. You can then view the changes by going to http://localhost:8080/[path], such as http://localhost:8080/articles/welcome.html.

Note: the local preview currently doesn't contain any themes at the moment so the look and feel won't be the same as in the documentation site. We're working towards fixing that experience.