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

# Contributing

Plimsoll takes part in the [Drips Stellar Wave](https://www.drips.network/wave/stellar). Issues across the three repos carry complexity labels and are scoped so one contributor can finish one in a Wave.

## Where the work is

| Repo        | Open issues                                                                                 |
| ----------- | ------------------------------------------------------------------------------------------- |
| Contracts   | [plimsoll-contracts/issues](https://github.com/plimsoll-protocol/plimsoll-contracts/issues) |
| App and SDK | [plimsoll-app/issues](https://github.com/plimsoll-protocol/plimsoll-app/issues)             |
| Indexer     | [plimsoll-indexer/issues](https://github.com/plimsoll-protocol/plimsoll-indexer/issues)     |

Start with `good first issue` if you are new to the codebase.

## How to contribute

1. Comment on the issue to be assigned. Wait for assignment.
2. Fork, branch, and make one change per pull request.
3. Run the repo's checks locally. CI runs the same job (`test`) and it must pass.
4. Use Conventional Commits: `feat(ledger): …`, `fix(web): …`.
5. Link the issue in the pull request (`Closes #12`).

Each repo's `CONTRIBUTING.md` lists its exact checks and coding standards.

## Rules that span repos

* Contract events are an interface. Changing one needs an issue in both `plimsoll-contracts` and `plimsoll-indexer`, cross-referenced with "Depends on".
* A frontend feature that needs a new contract function waits until that function is deployed to testnet.
* Amounts are integers in smallest units everywhere. No floats for money.

## Security

Report vulnerabilities privately through each repo's **Security** tab.


---

# 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://plimsoll-protocol.gitbook.io/plimsoll-protocol-docs/project/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.