Thanks for deciding to contribute to the Buildkite Docs. This guide covers what you need to know to make a contribution.
- Fork and clone the repository (see the README for setup instructions).
- Create a new branch for your changes.
- Make your changes, following the style guides below.
- Preview your changes locally by running the development server.
- Open a pull request against
main.
Before writing or editing content, review the relevant style guides in the /styleguides folder:
- Writing style: Language, tone, voice, terminology, and formatting standards for all Buildkite documentation.
- Markdown syntax style: The specific Markdown syntax used to write the docs, including headings, lists, links, callouts, tables, code blocks, and screenshots.
- Working with the docs site: How to add new pages, configure navigation, work with the file structure, and understand the site build process.
- YAML documentation: Guidelines for writing about and presenting YAML in documentation, including correct terminology and code formatting conventions.
If something isn't covered in these guides, refer to the Google developer documentation style guide, followed by the Microsoft Style Guide.
- Use US English and active voice.
- Use sentence case for headings.
- Use serial commas.
- Run the site locally and check your changes render correctly before opening a PR.