> For the complete documentation index, see [llms.txt](https://manual.picketstudio.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://manual.picketstudio.com/technology/contributing.md).

# Contributing to a codebase

Having a seamless and reliable deployment pipeline is crucial for rapid development. We use a git-based [feature branch workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/feature-branch-workflow) together with [CircleCI](https://circleci.com/) and [Heroku flow](https://www.heroku.com/flow). This allows us to deploy well-tested code to production multiple times a day.

When contributing to the codebase, it's important to follow the conventions of the organisation as well as those particular to the project itself. Everything from creating descriptive commit messages to notifying the right person at the right time will result in a better development experience for yourself and others.

## Developer

* [ ] Creates a local feature branch based off `master` using a [consistent naming convention](https://docs.microsoft.com/en-us/azure/devops/repos/git/git-branching-guidance?view=azure-devops#name-your-feature-branches-by-convention)
* [ ] When feature is complete and tests pass, commits the changes with a [good](https://chris.beams.io/posts/git-commit/) [commit](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) [message](https://github.com/torvalds/linux/pull/17#issuecomment-5659933)
* [ ] Pushes their branch to the remote
* [ ] Submits a [pull request](https://help.github.com/en/articles/about-pull-requests) (PR)
* [ ] Adds the corresponding issue # in the PR description using [GitHub keywords](https://help.github.com/en/articles/closing-issues-using-keywords) such as "Fixes", "Closes", "Resolves"
* [ ] A [Heroku Review App](https://devcenter.heroku.com/articles/github-integration-review-apps#viewing-review-apps) will be generated
* [ ] Requests a code review by assigning someone as a reviewer
* [ ] Addresses any of the requested changes or feedback provided by the reviewer
* [ ] Read: [Google Engineering Practices](https://google.github.io/eng-practices/review/reviewer/)

## Code reviewer (Systems architect)

* [ ] Reviews the code on the branch, adhering to the [code review guidelines](https://github.com/thoughtbot/guides/tree/master/code-review)
* [ ] If there are any changes required, requests them
* [ ] Once it looks ready, approves the PR
* [ ] Assigns the PR to the QA

## Quality Assurance (QA)

* [ ] Tests the Review App generated by Heroku
* [ ] Adds either a `QA passed` or `QA failed` label to the PR.
* [ ] If `QA failed` label is attached, assigns the PR back to the author
* [ ] Once `QA passed` label is attached - Merges PR.

*If the issue # is linked in the description, this will automatically close the issue and notify the PM*

**NB: Any merges into `master` are automatically deployed to a Heroku staging app**

* [ ] Deletes the branch

## Product Manager (PM)

* [ ] Checks the Heroku staging app is working as intended
* [ ] Updates the issue with any additional information, if required
* [ ] Promotes to **live** when ready


---

# 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, and the optional `goal` query parameter:

```
GET https://manual.picketstudio.com/technology/contributing.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.