> For the complete documentation index, see [llms.txt](https://ai-os-and-trend-finder.gitbook.io/ai-os-and-trend-finder-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ai-os-and-trend-finder.gitbook.io/ai-os-and-trend-finder-docs/contributing.md).

# Contributing

## Branch Conventions

* `main` - Current integration branch for this private project.
* `feature/*` - New features.
* `fix/*` - Bug fixes.
* `docs/*` - Documentation changes.

## Commit Style

Use concise conventional commits when practical:

* `feat:` for features.
* `fix:` for bug fixes.
* `docs:` for documentation.
* `refactor:` for internal restructuring.
* `test:` for tests.

## Pull Request Process

1. Create a focused branch from `main`.
2. Make changes with clear commits.
3. Run the full quality gate before opening the PR:

   ```bash
   bun run typecheck
   bun run format:check
   bun run lint
   bun run test
   bun run build
   ```
4. Update docs when behavior, setup, routes, scripts, data models, or deployment change.
5. Open a PR with the problem, solution, and verification notes.

## Local Safety

* Do not commit `.env.local`, `src/data/live-data.json`, or private machine output.
* Keep `git config --local core.hooksPath .githooks` enabled so the pre-commit secret scan runs.
* Use short placeholder values in examples instead of real-looking API keys.


---

# 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://ai-os-and-trend-finder.gitbook.io/ai-os-and-trend-finder-docs/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.