Merge pull request #227 from documenso/docs-coventional-commits

docs: conventional commits
This commit is contained in:
Lucas Smith
2023-07-31 13:00:55 +10:00
committed by GitHub

View File

@@ -10,7 +10,10 @@ If you plan to contribute to Documenso, please take a moment to feel awesome ✨
## 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://documen.so/slack).
- 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://documen.so/slack).
- 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
@@ -20,7 +23,7 @@ The development branch is <code>main</code>. All pull request should be made aga
- Create a new branch (include the issue id and something readable):
```sh
git checkout -b doc-999-my-feature-or-fix
git checkout -b feat/doc-999-somefeature-that-rocks
```
3. See the [Developer Setup](https://github.com/documenso/documenso/blob/main/README.md#developer-setup) for more setup details.