Skip to main content

​
Contributing to Documenso

If you plan to contribute to Documenso, please take a moment to feel awesome. People like you are what open source is about. Any contributions, no matter how big or small, are highly appreciated. This guide will help you get started with contributing to Documenso.

​
Before Getting Started

​
Taking Issues

Before taking an issue, ensure that:
  • The issue has been assigned the public label.
  • The issue is clearly defined and understood.
  • No one has been assigned to the issue.
  • No one has expressed the intention to work on it.
After that:
  1. Comment on the issue with your intention to work on it.
  2. Start working on the issue.
Feel free to ask for help, clarification or guidance if needed. We are here to help you.

​
Developing

The development branch is main, and all pull requests should be made against this branch. Here’s how you can get started with developing:
If you need help getting started, join us on Discord.

​
Building

Before pushing code or creating pull requests, please ensure you can successfully create a successful production build. You can build the project by running the following command in your terminal:
Once the project builds successfully, you can push your code changes or create a pull request.
Remember to run tests and perform any necessary checks before finalizing your changes. As a result, we can collaborate more effectively and maintain a high standard of code quality in our project.