diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5aeb61c1b..f580e13c8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,7 +10,10 @@ If you plan to contribute to Documenso, please take a moment to feel awesome ✨ ## Developing -The development branch is main. 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). +* The development branch is main. 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 @@ -20,7 +23,7 @@ The development branch is main. 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 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.