2023-03-14 10:28:13 +01:00
# Contributing to Documenso
2023-03-17 15:26:41 +01:00
2023-03-14 10:28:13 +01:00
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.
## Before getting started
2023-03-17 15:26:41 +01:00
2023-03-14 10:28:13 +01:00
- Before jumping into a PR be sure to search [existing PRs ](https://github.com/documenso/documenso/pulls ) or [issues ](https://github.com/documenso/documenso/issues ) for an open or closed item that relates to your submission.
2023-03-14 09:45:37 +01:00
- Select and issue from [here ](https://github.com/documenso/documenso/issues ) or create a new one
2023-03-14 10:28:13 +01:00
- Consider the results from the discussion in the issue
## Developing
2023-03-17 15:26:41 +01:00
2023-07-18 12:03:14 +02:00
- The development branch is <code>main</code>. All pull request should be made against this branch.
2023-07-19 07:54:03 +02:00
- If you need help getting started, [join us on Slack ](https://documen.so/slack ).
2023-08-04 02:14:04 +02:00
- Use [Conventional Commits ](https://www.conventionalcommits.org/ ) to keep everything nice and clean.
2023-07-18 12:03:14 +02:00
- Choose your branch name using the issue you are working on and a coventional commit type.
2023-03-14 10:28:13 +01:00
1. [Fork ](https://help.github.com/articles/fork-a-repo/ ) this repository to your
own GitHub account and then
[clone ](https://help.github.com/articles/cloning-a-repository/ ) it to your local device.
2. Create a new branch:
2023-03-17 15:26:41 +01:00
2023-06-02 20:01:10 +00:00
- Create a new branch (include the issue id and something readable):
2023-03-14 10:28:13 +01:00
2023-03-17 15:26:41 +01:00
```sh
2023-07-18 11:59:59 +02:00
git checkout -b feat/doc-999-somefeature-that-rocks
2023-03-17 15:26:41 +01:00
```
2023-03-14 10:28:13 +01:00
3. See the [Developer Setup ](https://github.com/documenso/documenso/blob/main/README.md#developer-setup ) for more setup details.
2023-03-17 15:26:41 +01:00
## Building
> **Note**
> Please be sure that you can make a full production build before pushing code or creating PRs.
2023-03-14 10:28:13 +01:00
You can build the project with:
```bash
npm run build
```