Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
37 lines (24 loc) · 2.27 KB

CONTRIBUTING.md

File metadata and controls

37 lines (24 loc) · 2.27 KB

Contributing

First of all, thanks for contributing! This document provides some basic guidelines for contributing to this repository. To propose improvements, feel free to submit a pull request.

The Documentation team adds style rules that address recurring issues of style or terminology in our Documentation repo. We are aiming for utility, not completeness.

Opening issues

GitHub issues are welcome, so feel free to open an issue about an existing style rule. Make sure to add enough details and examples to explain your use case clearly.

For example, if you'd like the words.yml rule to flag on the word "Dirrty", open an issue and include a justification in the description such as, "Dirrty is the name of a 2002 Christina Aguilera song from her album Stripped. If an instance of "Dirrty" appears in the documentation, it is most likely a typo."

Are you having an issue with the Datadog product? Contact Datadog Support.

Submitting rules

Are you interested in contributing your team's product-specific terminology and vocabulary to the Documentation Site Style Guide?

  1. Create a folder such as [Product Name]-Names and add it to the Styles/Datadog folder.
  2. Update the CODEOWNERS file with your team's GitHub handle.
  3. Update the StylesPath to point to the appropriate directory in your team repository's .vale.ini file.

In order to ease and speed up our review, here are some items you can check for when submitting your pull request:

  • Keep commits small and focused, and rebase your branch if needed.
  • Write meaningful commit messages and pull request titles that are concise but explanatory.

If you are a Datadog employee, share your pull request in #documentation and a writer on the team will take a look.