> For the complete documentation index, see [llms.txt](https://docs.zama.org/tfhe-rs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.zama.org/tfhe-rs/developers/contributing.md). # Contributing This repository uses an **issue-first contribution workflow**. Pull Requests are disabled on the main repository. All contributions begin with a discussion in an issue so maintainers and contributors can align early on scope, design, compatibility, and maintenance implications before implementation work starts. ## How to Contribute If you would like to report a bug, propose a feature, or discuss a change, open an issue in the main repository. Please describe the problem clearly and, when possible, include context, motivation, or a proposed direction. Once the discussion reaches consensus, contributors may implement the change in a personal fork of the repository. ``` git checkout -b ext/feature/my-change ``` After pushing the branch to your fork, create a PR against your forked `main` branch and share the reference directly in the issue thread instead of opening a Pull Request against the upstream repository. Example: ``` https://github.com///pull/ ``` An official maintainer or contributor will review the proposed implementation, request changes if necessary, and integrate the contribution into the main repository. ## Why Pull Requests Are Disabled This workflow ensures that technical discussions happen before implementation and helps maintain consistency across the project. It also reduces review overhead and avoids contributors spending time on changes that may not align with the roadmap or architecture. Last and not least, it prevents security issues coming from external contributor PR. ## Guidelines Contributions are easier to review and integrate when they are focused, documented, and discussed early. Small, self-contained changes are generally preferred over large multi-purpose modifications. For security vulnerabilities, please follow the process described in `SECURITY.md` instead of opening a public issue. By contributing to this repository, you agree that your contributions will be licensed under the project license. The contribution guidelines are described in `CONTRIBUTION_GUIDELINES.md`. --- # 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.zama.org/tfhe-rs/developers/contributing.md?ask=&goal= ``` `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.