The Open Source DocuSign Alternative.
TypeScript digital-signaturedocument-signingdocusign-alternativee-signatureesignesignaturenext-authnextjsopen-sourcepades-standardpdfpdf-signpdf-signaturepostgresqlprismaself-hostedsigningtypescript
📝 contribution guide
Timur Ercanedc4f945349a
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.mdindex 833f93c16..06597fc7a 100644--- a/CONTRIBUTING.md+++ b/CONTRIBUTING.md@@ -1,2 +1,31 @@++# 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\ No newline at end of file+- Consider the results from the discussion in the issue++## Developing+The development branch is <code>development</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).++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+ ```+3. See the [Developer Setup](https://github.com/documenso/documenso/blob/main/README.md#developer-setup) for more setup details.+ ## Building++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 filediff --git a/README.md b/README.mdindex aee01b938..e217e940b 100644--- a/README.md+++ b/README.md@@ -78,11 +78,6 @@ Follow these steps to setup documenso on you local machnine:```shgit clone https://github.com/documenso/documenso```-- Create a new branch (include the issue id and somthing readable):-- ```sh- git checkout -b doc-999-my-feature-or-fix- ```- Run <code>npm i</code> in root directory- Rename .env.example to .env- Set DATABASE_URL value in .env file