# Contributing to Jolt-Qed

We welcome contributions from anyone willing to work in good faith with other contributors, and the community.

## Code Of Conduct

This project follows the
[Contributor Covenant Code of Conduct, version 2.1](https://www.contributor-covenant.org/version/2/1/code_of_conduct/).

## Issues

If you find a problem write to us.
For bug reports, and feature requests, please open an issue
in this repository.

For general questions, or other recommendations, you are welcome to email us at [jolt-qed@layerzerolabs.org](mailto:jolt-qed@layerzero-labs.org).
Before preparing your correspondence, please read the code of conduct above, and also make sure to follow the rules outlined [here](http://www.catb.org/esr/faqs/smart-questions.html).

## Pull Requests

### AI USAGE Policy 

Firstly, we expect AI agents to be part of developer workflows.
So it is perfectly reasonable to send us code written by an AI agent, as long as you have read and understood what your agent wrote, and can have a meaningful discussion about it.
Our aim is not to be particularly fussy about what is AI vs human generated. 
We just want to ensure our limited time is used most effectively at improving the security guarantees of the Jolt-zk-VM.
Briefly explain which tool(s) you used and how you used it. 

### Pull Request Guidelines

To contribute, open a pull request from your fork or open an issue to report a problem.

1. **Keep PRs focused:** Try to target one feature, proof, or bug fix per pull request.

2. **Use a descriptive title:** Use a short title that says what changed. No particular prefix is required.

3. **Verify locally:** Run `lake build` and ensure it completes successfully.

4. **Allow maintainer edits:** Please ensure the **"Allow edits from maintainers"** box is checked when opening your pull request. This allows maintainers to quickly fix minor typos, formatting, or lint issues directly on your branch, speeding up the review process.

5. **Documentation**: Explain what changed and why. If the change is a large re-organisation of the proofs that greatly simplify, and shorten existing proofs then reach out via the mailing list first so we can have a discussion.