Getting started
Learn how to contribute to Documenso and become part of our community.
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:
- Comment on the issue with your intention to work on it.
- 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:
Before working on an issue, ensure that no one else is working on it. If no one is assigned to the issue, you can pick it up by leaving a comment and asking to assign it to you.
feat/
for new features, fix/
for bug fixes, etc.git checkout -b feat/issue-id-your-branch-name
## Example
git checkout -b feat/1234-add-share-button-to-articles
references #yyyy
or fixes #yyyy
to link it to the issue you are working on.main
branch.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.