mirror of
https://github.com/documenso/documenso.git
synced 2025-11-12 07:43:16 +10:00
41 lines
1.7 KiB
Markdown
41 lines
1.7 KiB
Markdown
# 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.
|
|
|
|
## Before getting started
|
|
|
|
- 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.
|
|
- Select and issue from [here](https://github.com/documenso/documenso/issues) or create a new one
|
|
- Consider the results from the discussion in the issue
|
|
|
|
## Developing
|
|
|
|
* The development branch is <code>main</code>. All pull request should be made against this branch.
|
|
* If you need help getting started, [join us on Slack](https://join.slack.com/t/documenso/shared_invite/zt-1qwxxsvli-nDyojjt~wakhgBGl9JRl2w).
|
|
* Use [Convential Commits](https://www.conventionalcommits.org/) to keep everything nice and clean.
|
|
* Choose your branch name using the issue you are working on and a coventional commit type.
|
|
|
|
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:
|
|
|
|
- Create a new branch (include the issue id and something readable):
|
|
|
|
```sh
|
|
git checkout -b doc-999-feat-somefeature-that-rocks
|
|
```
|
|
|
|
3. See the [Developer Setup](https://github.com/documenso/documenso/blob/main/README.md#developer-setup) for more setup details.
|
|
|
|
## Building
|
|
|
|
> **Note**
|
|
> Please be sure that you can make a full production build before pushing code or creating PRs.
|
|
|
|
You can build the project with:
|
|
|
|
```bash
|
|
npm run build
|
|
```
|