Contributing template

How to work on one repository: local setup, branching, standards, tests, release. Organization-wide rules live in Contributing guidelines. This page covers what's specific to one repository. Lives at docs/repos/<repo>/contributing.md.

Generated by npm run new:repo.

Template

---
title: "Contributing"
description: "Local setup, workflow, standards, testing and release for {{repoName}}."
status: draft
---

# Contributing to {{repoName}}

TODO: Anything a new contributor must know first. Organization-wide rules are
in [Contributing guidelines](/contributing/guidelines).

## Prerequisites

| Tool | Version | Notes |
| --- | --- | --- |
| TODO | TODO | TODO |

## Local setup

```bash
# TODO: clone, install, configure, run
```

See [Configuration](./configuration) for environment variables.

## Branching and pull requests

TODO: Branch naming, PR size and review expectations, and who approves.

## Coding standards

TODO: Linting, formatting, naming, folder conventions and patterns to follow
or avoid.

## Testing

```bash
# TODO: how to run tests / linters / type checks
```

TODO: What must pass before merge, and what CI checks.

## Release and deploy

TODO: How changes reach users: the pipeline, manual steps and rollback.

## Review checklist

- [ ] TODO
- [ ] Docs updated (this site) if behavior changed

## Troubleshooting

TODO: Common setup or build failures and their fixes. Organization-wide issues
are in [Troubleshooting](/contributing/troubleshooting).

Placeholders

{{repoName}}  Display name of the repository