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

# Contributing

## Branch workflow

1. Create feature branch from `main`
2. Make focused changes (minimal diff)
3. Run `pytest tests/` for affected areas
4. Commit with conventional prefix: `fix(ui):`, `perf(swap):`, `docs:`, etc.
5. Open PR with description of behavior change

## Code rules

From `.cursorrules`:

| Rule          | Detail                                                           |
| ------------- | ---------------------------------------------------------------- |
| Architecture  | UI in `handlers/`, DB in `db_handler_aio.py`, chain in `swap.py` |
| Secrets       | `os.getenv()` only; never hardcode                               |
| Migrations    | Forward-only auto-migrate in `init_db()`; never drop `users.db`  |
| Logging       | Preserve existing `logger.info` / `logger.error`                 |
| External APIs | Handle timeouts gracefully; don't crash bot loop                 |
| Dead code     | No unused imports or placeholder comments                        |

## Database changes

When adding a user setting or schema field:

1. Add column via `PRAGMA table_info` check + `ALTER TABLE`
2. Backfill defaults with `UPDATE` if needed
3. Add DAO accessor in appropriate `db/*_dao.py`
4. Document in [Database and migrations](/architecture/database.md)

## Documentation

Update `docs/` when changing user-visible behavior, admin flows, or env variables.

## Pull request checklist

* [ ] Tests pass (or N/A documented)
* [ ] No secrets in diff
* [ ] Migration is idempotent
* [ ] Trading path smoke-tested if touched


---

# 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://docs.hipersnipe.com/development/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.