diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4c4165347..543c5e215 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,31 +1,37 @@ - # 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 development. 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). 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 somthing readable): - ```sh - git checkout -b doc-999-my-feature-or-fix - ``` + ```sh + git checkout -b doc-999-my-feature-or-fix + ``` + 3. See the [Developer Setup](https://github.com/documenso/documenso/blob/main/README.md#developer-setup) for more setup details. - ## Building + +## 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 ``` -> **Note** -> Please be sure that you can make a full production build before pushing code or creating PRs. \ No newline at end of file