Community Integration Contribution

Do you want to contribute your own integration? We'd love to work with you. Here's everything you need to know.

Guidelines

You can build an integration for any service that you want to use with Capacities. Feel free to reach out to us to discuss ideas. If you need help, or need additional routes or extensions of existing routes on the Capacities API, please let us know.

In return, we will promote your integration in our community, release notes, our website, in the app, and on our social media channels. We can also discuss a compensation or reward.

We expect you to follow these guidelines when building an integration:

• Open-source: We encourage you to open-source your integration. This will allow others to review and contribute to your code. This will build trust and transparency in the community and will strengthen the long-term viability of the integration. This is not a requirement, but it is highly encouraged.
• Maintenance and updates: You should maintain your integration and keep it up-to-date. This includes keeping up with the latest version of the Capacities API and fixing security problems. If you don't want to maintain your integration anymore, please let us know so we can find a solution.
• Follow security best practices: You should follow security best practices when building your integration. This includes storing API keys in a secure way and not exposing user data.
• Data protection and privacy: You should respect the privacy of our users and not collect any data that you don't need. You should also follow the GDPR and other data protection laws.
• Documentation: You should provide clear and comprehensive documentation for your integration. This should include how to install and use the integration, how to configure it, and how to troubleshoot common problems. We'll give you contribution rights to our documentation GitHub repository. Your integration will be listed in our documentation.

Submission process

To submit your integration, please share the following data with us via email at team@capacities.io:

1. Name: The name of your integration.
2. Description: A one sentence description of your integration
3. Logo: A logo for your integration. This should be a square image with a transparent background.
4. Information about the maintainer (this can also be a company or organization)
   • Name: Your name or the name of the maintainer of the integration. You can also choose to remain anonymous.
   • Email: Email address of the maintainer of the integration.
   • Social media link: If you want to be linked and mentioned, please provide a link to your preferred social media profile.
   • Profile image: A profile image for the maintainer. This is optional.
5. Access to the integration: Please share a link to the GitHub repository or any demo of your integration.

We'll review your submission and get back to you as soon as possible. It will be released and communicated in the next release of Capacities.

Update process

As described in the guidelines, you should keep your integration up-to-date. If you make changes to your integration, please follow these steps:

1. Submit a pull request in the documentation repository: Please update the documentation of your integration in our documentation repository. We will review and merge your changes.
2. Email us: Please send us an email at team@capacities.io with all changes. We'll share them with our next release notes with all users.
3. Update your integration before the next release: Please make sure to update your integration before the next release of Capacities. We will notify you about the release date.