Skip to content

Commit

Permalink
docs: update contribution guidelines (#1975)
Browse files Browse the repository at this point in the history
  • Loading branch information
ctrlc03 authored Dec 20, 2024
1 parent 8e1ab15 commit 11c5b29
Showing 1 changed file with 16 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,26 @@ All members of our community are expected to follow our [Code of Conduct](/docs/

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.
:::
Expand Down

0 comments on commit 11c5b29

Please sign in to comment.