> For the complete documentation index, see [llms.txt](https://rshurts.gitbook.io/production-ready-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://rshurts.gitbook.io/production-ready-documentation/guides/dev.md).

# Development Guide

Provide documentation to quickly on-board developers, so that they can begin contributing code and introducing changes into the deployment pipeline.

## Setup <a href="#setup" id="setup"></a>

Include step-by-step instructions for cloning the code, setting up the product, getting access, and verifying the environment is working correctly.

## Code Standards <a href="#code-standards" id="code-standards"></a>

Document the coding standards, including code styles and how to run and setup any linting or formatting tools necessary to adhere to the code style.

> **Tabs Versus Spaces**
>
> A lot of time can be spent debating code style, but don't let perfection prevent progress. Choose a style and just use it. Where possible, adopt community best-practices like [airbnb's JavaScript eslint config](https://www.npmjs.com/package/eslint-config-airbnb) or [Python's PEP-8](https://www.python.org/dev/peps/pep-0008/). If the language provides a canonical formatting tool, like `go fmt` or `terraform fmt`, use that.

Describe the use of version control and any branching or merging strategies or naming conventions to meet the code standards.

## Code Reviews <a href="#code-reviews" id="code-reviews"></a>

Outline the code review process and what the expectations for a good code review are. Detail how to provide and respond to feedback. If pull requests are used, document how to create and close them.

## Testing <a href="#testing" id="testing"></a>

Document the frameworks being used for unit, integration, and end-to-end (e2e) testing and how to run the tests. Include any metrics being tracked, like code coverage, and how to file a bug when one is found. Proper testing helps ensure a quality product and creates a "safety net" when refactoring.

## Deployment Pipeline <a href="#deployment" id="deployment"></a>

Describe the build system and deployment process, including descriptions and links to the different environments and build machines. Provide information for troubleshooting and debugging failed builds so a developer can quickly get the build back in the "green."


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://rshurts.gitbook.io/production-ready-documentation/guides/dev.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.