@maci-protocol/website 0.0.0-ci.2653bc0

package/versioned_docs/version-v1.2/typedoc/domainobjs/modules.md

@@ -0,0 +1,110 @@
+---
+title: Domainobjs Module
+sidebar_label: module
+sidebar_position: 1
+---
+
+## Table of contents
+
+### Classes
+
+- [Ballot](classes/Ballot.md)
+- [Keypair](classes/Keypair.md)
+- [Message](classes/Message.md)
+- [PCommand](classes/PCommand.md)
+- [PrivKey](classes/PrivKey.md)
+- [PubKey](classes/PubKey.md)
+- [StateLeaf](classes/StateLeaf.md)
+- [TCommand](classes/TCommand.md)
+- [VerifyingKey](classes/VerifyingKey.md)
+
+### Interfaces
+
+- [ICommand](interfaces/ICommand.md)
+- [IG1ContractParams](interfaces/IG1ContractParams.md)
+- [IG2ContractParams](interfaces/IG2ContractParams.md)
+- [IJsonBallot](interfaces/IJsonBallot.md)
+- [IJsonCommand](interfaces/IJsonCommand.md)
+- [IJsonKeyPair](interfaces/IJsonKeyPair.md)
+- [IJsonPCommand](interfaces/IJsonPCommand.md)
+- [IJsonStateLeaf](interfaces/IJsonStateLeaf.md)
+- [IJsonTCommand](interfaces/IJsonTCommand.md)
+- [IMessageContractParams](interfaces/IMessageContractParams.md)
+- [IStateLeaf](interfaces/IStateLeaf.md)
+- [IStateLeafContractParams](interfaces/IStateLeafContractParams.md)
+- [IVkContractParams](interfaces/IVkContractParams.md)
+- [IVkObjectParams](interfaces/IVkObjectParams.md)
+- [Proof](interfaces/Proof.md)
+- [VoteOptionTreeLeaf](interfaces/VoteOptionTreeLeaf.md)
+
+### Type Aliases
+
+- [IJsonPrivateKey](modules.md#ijsonprivatekey)
+- [IJsonPublicKey](modules.md#ijsonpublickey)
+
+### Variables
+
+- [SERIALIZED_PRIV_KEY_PREFIX](modules.md#serialized_priv_key_prefix)
+- [SERIALIZED_PUB_KEY_PREFIX](modules.md#serialized_pub_key_prefix)
+- [blankStateLeaf](modules.md#blankstateleaf)
+- [blankStateLeafHash](modules.md#blankstateleafhash)
+
+## Type Aliases
+
+### IJsonPrivateKey
+
+Ƭ **IJsonPrivateKey**: `Pick`\<[`IJsonKeyPair`](interfaces/IJsonKeyPair.md), `"privKey"`\>
+
+#### Defined in
+
+[types.ts:33](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/types.ts#L33)
+
+---
+
+### IJsonPublicKey
+
+Ƭ **IJsonPublicKey**: `Pick`\<[`IJsonKeyPair`](interfaces/IJsonKeyPair.md), `"pubKey"`\>
+
+#### Defined in
+
+[types.ts:35](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/types.ts#L35)
+
+## Variables
+
+### SERIALIZED_PRIV_KEY_PREFIX
+
+• `Const` **SERIALIZED_PRIV_KEY_PREFIX**: `"macisk."`
+
+#### Defined in
+
+[privateKey.ts:5](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/privateKey.ts#L5)
+
+---
+
+### SERIALIZED_PUB_KEY_PREFIX
+
+• `Const` **SERIALIZED_PUB_KEY_PREFIX**: `"macipk."`
+
+#### Defined in
+
+[publicKey.ts:7](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/publicKey.ts#L7)
+
+---
+
+### blankStateLeaf
+
+• `Const` **blankStateLeaf**: [`StateLeaf`](classes/StateLeaf.md)
+
+#### Defined in
+
+[constants.ts:3](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/constants.ts#L3)
+
+---
+
+### blankStateLeafHash
+
+• `Const` **blankStateLeafHash**: `bigint`
+
+#### Defined in
+
+[constants.ts:4](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/constants.ts#L4)

package/versioned_docs/version-v1.2/typedoc/index.md

@@ -0,0 +1,4 @@
+---
+title: Typedoc
+sidebar_label: Typedoc
+---

package/versioned_docs/version-v1.2/versioning.md

@@ -0,0 +1,94 @@
+---
+title: MACI versioning and release process
+description: How MACI's versioning and release process works
+sidebar_label: MACI versioning
+sidebar_position: 20
+---
+
+# MACI versioning and release process
+
+This document outlines the approach to versioning and releasing the MACI project. The primary goal here is to set clear expectations and provide a consistent user experience for developers integrating MACI and its packages.
+
+## MACI code
+
+MACI code consists 3 core parts: Circom circuits, Solidity contracts and JS (TS) libraries, from which we release a total of 7 NPM packages. See the [codebase overview](/docs/v1.2/overview) for more details.
+
+## MACI versioning
+
+MACI follows the [Semantic Versioning Specification (SemVer)](https://semver.org/).
+
+All MACI packages are organized in our monorepo and follow a global release approach, meaning that all packages have the same version.
+
+Currently, MACI core team manually decides when to release and what the version should be. Packages are released [automatically via CI](https://github.com/privacy-scaling-explorations/maci/blob/dev/.github/workflows/release.yml) when a new tag is created in GitHub. [You can view our releases and tags in GitHub](https://github.com/privacy-scaling-explorations/maci/releases).
+
+## MACI Release Process
+
+To release a new version of MACI, follow these steps:
+
+:::warning
+Version number '1.2.3' is used here as an example. You should replace the version number '1.2.3' with the version number you are planning to release
+:::
+
+1. Verify that tests have passed on GitHub Actions
+
+2. Clone maci:
+
+```
+git clone https://github.com/privacy-scaling-explorations/maci
+```
+
+3. Switch to the `dev` branch:
+
+```
+git checkout dev
+```
+
+4. Install required dependencies:
+
+```
+pnpm install
+```
+
+5. Run `lerna version` to update CHANGELOG and version numbers of sub-packages:
+
+```
+pnpm exec lerna version --no-push --no-git-tag-version --conventional-commits 1.2.3
+```
+
+6. Commit changes:
+
+```
+git commit --message "chore(release): publish 1.2.3"
+```
+
+7. Push changes and create a pull request
+
+After the pull request has been merged:
+
+8. Retrieve merged commit
+
+9. Add a tag:
+
+```
+git tag --sign v1.2.3 --message v1.2.3
+```
+
+10. Publish tag:
+
+```
+git push v1.2.3
+```
+
+Once the tag is pushed, GitHub Actions will automatically publish the packages to npm.js and create a release on GitHub.
+
+---
+
+The following packages will be published on NPM:
+
+- [`@maci-circuits`](https://www.npmjs.com/package/maci-circuits)
+- [`@maci-contracts`](https://www.npmjs.com/package/maci-contracts)
+- [`@maci-cli`](https://www.npmjs.com/package/maci-cli)
+- [`@maci-core`](https://www.npmjs.com/package/maci-core)
+- [`@maci-crypto`](https://www.npmjs.com/package/maci-crypto)
+- [`@maci-domainobjs`](https://www.npmjs.com/package/maci-domainobjs)
+- [`@maci-integrationtests`](https://www.npmjs.com/package/maci-integrationtests)

package/versioned_docs/version-v1.2/workflow.md

@@ -0,0 +1,142 @@
+---
+title: MACI Workflow
+description: Overview of the MACI workflow
+sidebar_label: Workflow
+sidebar_position: 3
+---
+
+<!-- TODO: create flowcharts, similar to Kyle's (but make light/dark mode compatible) -->
+
+# MACI Workflow
+
+This article covers the high-level MACI workflow, which borrows heavily from our [Technical Introduction to MACI](/blog/maci-1-0-technical-introduction#system-overview).
+
+## Roles
+
+There are two key roles that participate in MACI:
+
+1. Users, who vote on polls
+2. A trusted coordinator, who configures and launches polls, tallies up votes, and publishes the final results
+
+### User (voter)
+
+A "User" is any voter in a MACI poll.
+
+In order to participate in a MACI poll, a user will perform at least 2 on-chain transactions:
+
+1. Sign up with MACI
+2. Vote on a poll
+
+<!-- TODO: add flowchart that demonstrates this (but show happy path, not key switching) -->
+<!-- https://miro.medium.com/v2/resize:fit:1400/format:webp/0*whHfC8-xxAwSyaaO -->
+
+### Coordinator
+
+The "Coordinator" helps set up and execute MACI polls. They are responsible for deploying the MACI smart contracts, initiating polls, tallying the final results of a vote, and finalizing polls by publishing the final results on-chain.
+
+:::info
+Note: it's possible for the contract deployer and the coordinator to be two separate accounts/entities, but for simplicity we'll start by assuming these functions are the same role.
+:::
+
+Once a voting poll has completed (i.e. the voting deadline has elapsed), the coordinator has the sole ability to decrypt all user votes and tally up the total results. The coordinator then publishes commitments and proofs of these results on chain to finalize a poll. The coordinators must use zk-SNARKs proofs to guarantee that their final tally result is valid, and this is accomplished without releasing the vote of every individual.
+
+<!-- In order to execute a MACI poll, a coordinator will perform at least 3 types of on-chain transactions:
+
+1. deploy contracts
+2. -->
+
+#### Trust assumptions
+
+We say the coordinator is a "trusted" coordinator, because there are areas where a corrupt (or inept) coordinator could disrupt the "happy path" of the MACI workflow.
+
+For instance, a coordinator can:
+
+- Decrypt votes (in order to publish them, or to bribe individual voters)
+- Halt a round (by never tallying results or never submitting the final proofs)
+
+A coordinator cannot:
+
+- Publish incorrect results (either by censoring valid votes or creating fraudulent votes)
+- Change the parameters of a poll (e.g. by extending its voting deadline once it's been deployed)
+
+Therefore, even if a coordinator is corrupt, they are unable to change a user’s vote or add extra votes themselves. A corrupt coordinator can stop a vote by never publishing the results, but they can’t publish false results.
+
+## Contracts
+
+To explain the MACI workflow, let's give a quick overview of the key smart contracts.
+
+See our [smart contract docs](/docs/v1.2/contracts) or our [contract source code](https://github.com/privacy-scaling-explorations/maci/tree/dev/contracts/contracts) for a more in-depth explanation of all smart contracts.
+
+### MACI.sol
+
+The MACI contract is responsible for registering user signups by recording the initial public key for each user (via the [`signUp` function](/docs/v1.2/solidity-docs/MACI#signup-1)). To conduct a voting round, the coordinator can deploy a Poll via MACI (with the [`deployPoll` function](/docs/v1.2/solidity-docs/MACI#deploypoll)).
+
+### Poll.sol
+
+The Poll contract is where users submit their votes (via the [`publishMessage` function](/docs/v1.2/typedoc/core/classes/Poll#publishmessage)). One MACI contract can be used for multiple Poll contracts. In other words, a user that signed up to the MACI contract can vote on multiple issues, with each issue represented by a distinct Poll contract.
+
+### MessageProcessor.sol and Tally.sol
+
+The MessageProcessor and Tally contracts are used by the coordinator to process all user votes and to prove on-chain that they correctly tallied each vote.
+
+## Poll lifecycle
+
+As described above, a core contract of MACI is a Poll. Coordinators can deploy polls and add vote options to polls, which users can then vote on. Although each instance of MACI can deploy multiple Polls, only one Poll can be active at a time.
+
+In essence, each MACI Poll is a state machine which has 3 stages:
+
+1. Open
+2. Closed
+3. Finalized
+
+### 1) Open
+
+When a Poll is deployed, its voting period starts immediately. As part of its deployment, the `duration` of the Poll is set, which determines how long the Poll is open for voting. A Poll is "open" until the duration of the Poll has elapsed.
+
+During this stage, users can sign up and vote.
+
+#### Sign up
+
+Before a user can cast a vote, they must sign up by generating a MACI keypair and then sending the public key they wish to use to cast their vote to the MACI smart contract. This MACI public key (distinct from their Ethereum account public key) acts as their identity when voting. Users can vote from any Ethereum address, but their message must contain a signature from that MACI public key.
+
+This registration process is necessary to fortify MACI against Sybil attacks. The particular criteria used to allow user signups is customizable, and can be configured using any [SignUpGatekeeper contract](https://github.com/privacy-scaling-explorations/maci/blob/v1.2.0/packages/contracts/contracts/gatekeepers/SignUpGatekeeper.sol). This contract dictates the criteria a user must pass in order to participate in a poll. For example, a user might need to prove ownership of a certain NFT, or that they've received some attestation on EAS, or prove that they have passed some sort of proof-of-personhood verification. Note that MACI presumes an identity system where each legitimate member
+controls a unique private key - MACI does not specifically solve for this, but allows for customization on how this is configured.
+
+#### Vote
+
+Once a user has signed up with MACI, they are eligible to vote on open polls.
+
+To cast a vote, a user will bundle a few variables — including a public key, their vote option, their vote amount, and a few others — into what is called a "command". Then, the user signs the command with the public key they originally used to sign up. After that, the user encrypts the signature and command together so that it is now considered a "message". If the command is properly signed by the user’s MACI public key, then the message is considered valid will be counted in the final tally. Therefore, the MACI public key can be thought of as the user’s voting username, and the signature is the voting password. If they provide the correct signature, they can submit a vote.
+
+Before sending their vote on-chain, users encrypt their vote using a shared key that only the user and coordinator can know. This key scheme is designed so that every individual user shares a distinct key with the coordinator. This prevents any bribers from simply reading the transaction data to see which option a user voted for. It also allows the coordinator to decrypt user votes (so that they can tally the results).
+
+### 2) Closed
+
+A Poll is "closed", when the voting period ends. At this point, no users may submit any more votes. The Poll remains closed until the coordinator tallies the final results.
+
+At this point, the coordinator must process all the messages, tally the results, and publish the proofs on-chain.
+
+#### Process Messages
+
+Once the voting period has completed for a specific poll, the coordinator will use the `MessageProcessor` contract to first prove that they have correctly decrypted each message and applied them to correctly create an updated state tree. This state tree keeps an account of all the valid votes that should be counted. So, when processing the messages, the coordinator will not keep messages that are later overridden by a newer message inside the state tree. For example, if a user votes for option A, but then later sends a new message to vote for option B, the coordinator will only count the vote for option B.
+
+The coordinator must process messages in batches so that proving on chain does not exceed the data limit. The coordinator then creates a zk-SNARK proving their state tree correctly contains only the valid messages. Once the proof is ready, the coordinator calls [`MessageProcessor.processMessages()`](/docs/v1.2/solidity-docs/MessageProcessor#processmessages), providing a hash of the state tree and the zk-SNARK proof as an input parameters.
+
+The `MessageProcessor` contract will send the proof to a separate verifier contract. The verifier contract is specifically built to read MACI zk-SNARK proofs and tell if they are valid or not. So, if the verifier contract returns true, then everyone can see on-chain that the coordinator correctly processed that batch of messages. The coordinator repeats this process until all messages have been processed.
+
+#### Tally Results
+
+Finally, once all messages have been processed, the coordinator tallies the votes of the valid messages (off-chain). The coordinator creates a zk-SNARK proving that the valid messages in the state tree (proved in Process Messages step) contain votes that sum to the given tally result. Then, they call [`Tally.tallyVotes()`](/docs/v1.2/solidity-docs/Tally#tallyvotes) with a hash of the correct tally results and the zk-SNARK proof. Similarly to the processMessages function, the `tallyVotes` function will send the proof to a verifier contract to ensure that it is valid.
+
+<!-- "hash of the correct tally results" - so are the final results actually put on chain? or just a hash?? -->
+
+The `tallyVotes` function is only successful if the verifier contract returns that the proof is valid. Therefore, once the `tallyVotes` function succeeds, users can trust that the coordinator has correctly tallied all of the valid votes. After this step, anyone can see the final tally results and the proof that these results are a correct result of the messages sent to the Poll contract. The users won’t be able to see how any individual voted, but will be able to trust that these votes were properly processed and counted.
+
+<!-- "After this step, anyone can see the final tally results" - how if only hash of results are published? -->
+<!-- https://miro.medium.com/v2/resize:fit:1400/format:webp/0*7Le2odbX7e2etpxR -->
+
+### 3) Finalized
+
+A poll is "finalized" after the coordinator processes all the messages, tallies the results, and publishes the on-chain proofs.
+
+At this point, the final results of a poll can be announced, and anyone can verify that the results have been processed and calculated correctly by the coordinator.

package/versioned_docs/version-v2.x/case-studies.md

@@ -0,0 +1,35 @@
+---
+title: Case Studies
+description: Overview of what is quadratic funding
+sidebar_label: Case Studies
+sidebar_position: 12
+---
+
+# Case Studies
+
+View some of our previous collaborations below!
+
+Public Good rounds come in different shapes in sizes. The hope is that these projects will provide inspiration for prospective organizers on how they may want to structure their QF round.
+
+## 2024
+
+- [ETH Mexico](https://pse-team.notion.site/case-study-eth-mexico-24?pvs=74)
+- [Cryptoversidad](https://pse-team.notion.site/Cryptoversidad-24-159d57e8dd7e80c88407cfaf6f538f3e?pvs=4)
+- [Ethereum TGU: Trust Round](https://pse-team.notion.site/case-study-ethereum-tgu-24-trust-round?pvs=74)
+- [Devcon Sea](https://pse-team.notion.site/case-study-devcon-sea-24?pvs=74)
+- [Ethereum TGU: Academy Round](https://pse-team.notion.site/Ethereum-TGU-24-Academia-Round-17ad57e8dd7e804ab65be5b6f3e6d7c3?pvs=4)
+
+## 2023
+
+- [ETH Honduras](https://www.notion.so/pse-team/ETH-Honduras-23-8a73c9ce00bf40e896bf6a1caf946710?pvs=4)
+- [ETH Argentina](https://www.notion.so/pse-team/ETH-Argentina-23-4836cbac426e4e4cbc56af7b639aa47b?pvs=4)
+- [ETHCon Korea](https://www.notion.so/pse-team/ETHCon-Korea-23-38a7c83ab66b4f5f8694141583da5c0a?pvs=4)
+
+## 2022
+
+- [ETH Honduras](https://www.notion.so/pse-team/ETH-Honduras-22-d1790da6ea0a45f38fdf023a6d10ef46?pvs=4)
+- [ETH LATAM](https://www.notion.so/pse-team/ETHLatam-22-6250f0f076984879aa38078d212a61f1?pvs=4)
+- [ETH Barcelona](https://www.notion.so/pse-team/ETHBarcelona-22-15a5c2d1464c41429d0865b59a4e3242?pvs=4)
+- [ETH Colombia](https://www.notion.so/pse-team/ETHColombia-22-af1faa11a6d24c36b7ec846e1f2bfc5d?pvs=4)
+- [ETH Prague](https://www.notion.so/pse-team/ETHPrague-22-948c98e6e2fd4b509d44cfc7445bdff6?pvs=4)
+- [ETH Dam](https://www.notion.so/pse-team/ETHDam-23-131c320619db4a75b9478bb39ad1d793?pvs=4)

package/versioned_docs/version-v2.x/contributing/_category_.json

@@ -0,0 +1,4 @@
+{
+  "label": "Contributing",
+  "position": 10
+}

package/versioned_docs/version-v2.x/contributing/code-of-conduct.md

@@ -0,0 +1,92 @@
+---
+title: MACI Contributor Code of Conduct
+description: The Contributor Covenant Code of Conduct for MACI
+sidebar_label: Code of Conduct
+sidebar_position: 2
+---
+
+# Contributor Covenant Code of Conduct
+
+Please see our guide on [contributing to MACI](/docs/contributing).
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version 2.0, [available here](https://www.contributor-covenant.org/version/2/0/code_of_conduct.html).
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+For answers to common questions about this code of conduct, see [the FAQ](https://www.contributor-covenant.org/faq). [Translations are available here](https://www.contributor-covenant.org/translations).

package/versioned_docs/version-v2.x/contributing/contributing.md

@@ -0,0 +1,149 @@
+---
+title: Contributing to MACI
+description: Instructions on how to contribute to MACI
+sidebar_label: Contributing
+sidebar_position: 1
+---
+
+# Contributing
+
+🎉 Thank you for being interested in contributing to MACI! 🎉
+
+Feel welcome and read the following sections in order to know how to ask questions and how to work on something.
+
+All members of our community are expected to follow our [Code of Conduct](/docs/contributing/code-of-conduct). Please make sure you are welcoming and friendly in all of our spaces.
+
+We're really glad you're reading this, because we need volunteer developers to help this project come to fruition. There is a lot we want to achieve, and this can only be made possible thanks to your support. 👏
+
+**Disclaimer**: We do not accept minor grammatical fixes (e.g., correcting typos, rewording sentences) unless they significantly improve clarity in technical documentation. These contributions, while appreciated, are not a priority for merging. If there is a grammatical error feel free to message the team [here](https://discord.gg/akDcCB69).
+
+## How You Can Contribute
+
+1. **Report Bugs**: Identify and describe issues.
+2. **Suggest Features**: Share your ideas for improvements.
+3. **Code Contributions**: Fix bugs, add features, or refactor existing code.
+4. **Improve Documentation**: Help us keep the docs clear and up to date.
+5. **Engage with the Community**: Help answer questions or participate in discussions.
+
+## Issues
+
+The best way to contribute to our projects is by opening a [new issue](https://github.com/privacy-scaling-explorations/maci/issues) or tackling one of the issues listed [here](https://github.com/privacy-scaling-explorations/maci/contribute).
+
+Before submitting an issue:
+
+- Search existing issues to avoid duplicates
+- Check documentation/FAQ
+- Test with the latest version
+
+:::info
+If you pick up an issue and are assigned to it by the maintaining team, please be advised that from time to time the team will reach out to check on the progress of the work. If you are working on the issue you are assigned but need more time or help, please let us know and we will be happy to assist you. We understand that contributors have other commitments too, and we appreciate every contribution, no matter the pace. If you fail to respond after 2 weeks, we will gently remind you to provide an update. If there is still no activity after that, we may reassign the issue to ensure project momentum, but we also welcome you to reengage with the project at any time when you are more available.
+:::
+
+## Pull Requests
+
+Pull requests are great if you want to add a feature or fix a bug. Here's a quick guide:
+
+1. Ensure there is an issue tracking your work.
+
+2. Fork the repo.
+
+3. Run the tests. We only take pull requests with passing tests.
+
+4. Add a test for your change. Only refactoring and documentation changes require no new tests.
+
+5. Make sure to check out the [Style Guide](#style-guide) and ensure that your code complies with the rules.
+
+6. Make sure you read our [GitHub processes](https://github.com/privacy-scaling-explorations/maci/discussions/847) documentation.
+
+7. Make the test pass.
+
+8. Commit your changes. Please make sure your forked `dev` branch is synced as well feature/fix branch and there are no "temp" commits (like wip, fix typo/lint/types and etc). We recommend to squash the feature/fix branch commits before creating PR. You can use this command for it:
+
+```bash
+git reset $(git merge-base dev $(git rev-parse --abbrev-ref HEAD))
+```
+
+9. Push to your fork and submit a pull request on our `dev` branch. Please provide us with some explanation of why you made the changes you made. For new features make sure to explain a standard use case to us.
+
+10. Link any issues that the PR is addressing as described in our processes documentation.
+
+## CI (Github Actions) Tests
+
+We use GitHub Actions to test each PR before it is merged.
+
+When you submit your PR (or later change that code), a CI build will automatically be kicked off. A note will be added to the PR, and will indicate the current status of the build.
+
+Please refer to our [testing guide](/docs/testing) for more details on how we run tests across the monorepo.
+
+## Style Guide
+
+### Code rules
+
+We always use ESLint and Prettier. To check that your code follows the rules, simply run the pnpm script `pnpm run lint` and `pnpm run prettier`. When committing, `eslint` is run automatically, so you will be required to fix any error before being able to push a commit. We highly recommend to tackle warnings as well.
+
+### Commits rules
+
+For commits it is recommended to use [Conventional Commits](https://www.conventionalcommits.org). You may install the [commitizen](https://commitizen-tools.github.io/commitizen/) tool to help you with this.
+
+Each commit message consists of a **header**, a **body** and a **footer**. The **header** has a special format that includes a **type**, a **scope** and a **subject**:
+
+```
+    <type>(<scope>): <subject>
+    <BLANK LINE>
+    <body>
+    <BLANK LINE>
+    <footer>
+```
+
+The **header** is mandatory and the **scope** of the header must contain the name of the component you are working on.
+
+#### Type
+
+The type must be one of the following:
+
+- feat: A new feature
+- fix: A bug fix
+- docs: Documentation only changes
+- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
+- refactor: A code change that neither fixes a bug nor adds a feature (improvements of the code structure)
+- perf: A code change that improves the performance
+- test: Adding missing or correcting existing tests
+- build: Changes that affect the build system or external dependencies (example scopes: gulp, npm)
+- ci: Changes to CI configuration files and scripts (example scopes: travis, circle)
+- chore: Other changes that don't modify src or test files
+- revert: Reverts a previous commit
+
+#### Scope
+
+The scope should be the name of the feature or package modified (as perceived by the person reading the changelog generated from commit messages).
+
+#### Subject
+
+The subject contains a succinct description of the change:
+
+- Use the imperative, present tense: "change" not "changed" nor "changes"
+- Don't capitalize the first letter
+- No dot (.) at the end
+
+#### Body
+
+Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior.
+
+### Branch rules
+
+- Branches should generally be created off of the base branch (`dev` )
+- Avoid long descriptive names for long-lived branches
+- Use kebab-case (no CamelCase)
+- Use grouping tokens (words) at the beginning of your branch names (in a similar way to the `type` of commit)
+- Define and use short lead tokens to differentiate branches in a way that is meaningful to your workflow
+- Use slashes to separate parts of your branch names
+- Remove branch after merge if it is not important
+
+Examples:
+
+```bash
+git branch -b docs/readme
+git branch -b test/a-feature
+git branch -b feat/sidebar
+git branch -b fix/b-feature
+```