Skip to content

Latest commit

 

History

History
36 lines (24 loc) · 1.71 KB

CONTRIBUTING.md

File metadata and controls

36 lines (24 loc) · 1.71 KB
Raw

Contribute

To contribute:

  1. Fork the guide repo.
  2. Pick a page/section and commit your changes.
  3. Open a PR

Tips:

  • Check the project page for issues. Assign yourself to an issue, if you start working on one.
  • (Optionally) Open an issue describing the page/section that you will be working on and assign the issue to yourself. See an example of an issue.
  • Read the Guidelines section.

Guidelines

Since we as a community are writing and contributing to different sections of the guide, it will need a lot of love, a bit of guidance and discipline. Here are a few things to the make the content of high-quality, coherent and consistent.

Vocabulary: Consult the glossary to keep the terminology consistent.

Voice: Write in second-person, active voice so that the content is concise, to the point yet personable.

Opinion Snippets: We encourage personal opinions, vendor choices, and quotes that add credibility to the content. A simple blockquote would make it stand out. For example:

I built an end-to-end CI/CD toolchain using [name tools]. - John Doe, CEO at Acme Corporation

Using [platform/service] from [vendor] has dramatically reduced our cost of doing business. - Mary Jane, CTO at Hooli

Proof-reading: Check your content for spelling mistakes and grammar. Grammarly is a pretty good tool.