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

# Contributing

Learn how to contribute to the DocBox project by submitting pull requests, reporting issues, and writing tests.

🤝 There are several ways you can help in the development of DocBox!

* 🔧 [Send a pull request](#send-a-pull-request)
* 🐛 Submit a bug or feature request to our [Jira issue tracker](https://ortussolutions.atlassian.net/projects/DOCBOX)
* ✅ [Write a test](#testing-docbox)

## 🔧 Send a Pull Request

* Fork [DocBox](https://github.com/Ortus-Solutions/DocBox) or the [DocBox documentation repo](https://github.com/ortus-docs/docbox-docs)
* Clone the repository fork to your machine - `git clone git@github.com:ME/DocBox.git`
* Create a `feature/` or `patch/` branch: `git checkout -b patch/syntax-error-in-html-output`
* Make your changes, commit as normal, and use `git push` to sync your commits to Github.
* Please target all PRs at the `development` branch.

## ✅ Testing DocBox

DocBox has a suite of Testbox specs validating that it works as expected. New features and bug fix PRs should (ideally) contain accompanying tests. Here's how to do that via CommandBox:

1. After cloning the repo, run `box install` to install development dependencies
2. Run `box start` to boot a test server
3. Run `box testbox run` to run the suite of DocBox tests.
4. Edit test specs in `tests/specs` as necessary, and run `box testbox run` again to validate tests pass.


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docbox.ortusbooks.com/readme/contributing.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
