Contribution Guidelines

[z-tech]

Contributing

Thank you for considering contributing to arkworks! Contributions come in many forms, such as participating in discussions or proposing code changes. To ensure a smooth workflow, please follow the general guidelines below.

Contribution Process

1. Find an issue to work on

   • Open a new issue or look for an existing one that interests you.
   • Engage in discussion to clarify details and align with maintainers.

2. Before starting development

   • If the issue is a feature proposal, ensure it has been approved.
   • Check if someone else is already working on it. If so, consider collaborating instead of duplicating efforts.
   • If the issue is unassigned, comment to express your intent to work on it.

3. Development workflow

   • Follow standard GitHub best practices:
     • Fork the repository
     • Branch from the latest master
     • Make commits in your branch
     • Submit a PR to master
   • Ensure your PR includes a relevant changelog entry in CHANGELOG.md under the "Pending" section.
     • If the change is breaking, migration instructions may be required.

Note: For minor fixes (e.g., typos, small isolated improvements), you don’t need to open an issue before submitting a PR. However, for larger or complex changes, discussing design in an issue beforehand helps reduce the likelihood of rejection.

Another Note: Spam and airdrop farming are not allowed. PRs that change only readme / comments or typos will be closed without review.

Looking for a good place to start? Check out some good first issues.

---

Branch Structure

• The default branch is master, where all PRs are merged.
• Releases are made periodically (without a fixed schedule).
• Other branches are for feature development.
• Downstream users should use tagged versions from Cargo.

---

Working on a Fork

Skip this section if you're already familiar with contributing to open-source GitHub projects.

1. Fork the repository from the GitHub UI and clone it locally.

2. Add the upstream repository (the original repo) as a remote:

   git remote add upstream [email protected]:arkworks-rs/algebra.git

3. Create a branch for your changes:

   git checkout master
   git pull upstream master
   git checkout -b my-feature-branch

4. Make your changes and submit a pull request to upstream/master.

---

Updating Documentation

All PRs should aim to improve documentation.

• Do not assume the code’s purpose is self-evident—complex protocols often require explanation.
• Where possible, provide a high-level overview before diving into implementation details.
• If applicable, reference relevant sections of academic papers or include brief proofs/arguments.

---

For More Information

For additional guidelines on respectful and productive collaboration, please refer to the GitHub Community Guidelines.

[z-tech]

Copying the existing guidelines from Algebra: https://github.com/arkworks-rs/algebra/blob/1971370f8dbbe34d7cf2dde90f71317d959b2da0/CONTRIBUTING.md

[Pratyush]

Thanks!