Skip to main content

Contribution Guide

Monoid is an open-source project that automates user data privacy requests. Our goal is to make it easy for users to delete and export their data from data silos in compliance with regulations like CPRA and GDPR.

If you're interested in contributing to Monoid, there are a few ways you can help:

Submitting New Connectors​

If you'd like to submit a new connector for a data silo, you'll need to follow our connector guide. Here's an overview of the steps:

  1. Install Monoid and its dependencies
  2. Fork the Monoid repository
  3. Create a new branch for your connector
  4. Create your connector according to the connector guide
  5. Submit a pull request (PR) with your connector

We'll review your PR and provide feedback. If it's accepted, your connector will be merged into the Monoid codebase.

Submitting Issues​

If you encounter a bug or have a suggestion for a new feature, you can submit an issue to the Monoid repository. Here's how:

  1. Go to the Monoid repository on GitHub
  2. Click on the "Issues" tab
  3. Click the "New Issue" button
  4. Fill out the form with a descriptive title and a detailed description of the issue
  5. Submit the issue

We'll review your issue and provide feedback. If it's a bug, we'll work on a fix. If it's a new feature request, we'll consider adding it to our roadmap.

Contributing to the Codebase​

If you'd like to contribute to the Monoid codebase, you can submit a PR with your changes. Before you do, please make sure to:

  1. Install Monoid and its dependencies
  2. Fork the Monoid repository
  3. Create a new branch for your changes
  4. Make your changes according to our coding guidelines
  5. Submit a PR with your changes

We'll review your PR and provide feedback. If it's accepted, your changes will be merged into the Monoid codebase.

Code of Conduct​

When contributing to Monoid, please keep in mind our code of conduct. We expect all contributors to behave in a respectful and professional manner.

License​

Monoid is licensed under the MIT License. By contributing to Monoid, you agree to license your contributions under the MIT License.