From c073032f5ae4a81ba2e050314b8119c477f75c1c Mon Sep 17 00:00:00 2001 From: Timur Ercan Date: Tue, 14 Mar 2023 09:45:37 +0100 Subject: [PATCH] contribution skeleton --- CONTRIBUTING.md | 2 ++ README.md | 20 +++++++++++++++----- 2 files changed, 17 insertions(+), 5 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..833f93c16 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,2 @@ +- 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 diff --git a/README.md b/README.md index fc1c737de..7b41af5e9 100644 --- a/README.md +++ b/README.md @@ -26,16 +26,18 @@ Signing documents digitally is fast, easy and should be best practice for every document signed worldwide. This is technically quite easy today, but it also introduces a new party to every signature: The signing tool providers. While this is not a problem in itself, it should make us think about how we want these providers of trust to work. Documenso aims to be the world's most trusted document signing tool. This trust is built by empowering you to self-host Documenso and review how it works under the hood. Join us in creating the next generation of open trust infrastructure. -## Community - -If you want to be part of Documenso you can: +## Community and Next Steps 🎯 +The current project goal is to release a production ready version for self-hosting as soon as possible. If you want to help making that happen you can: - Check out the first source code release in this repository - Tell us what you think in the current [Discussions](https://github.com/documenso/documenso/discussions) - Join the [Slack Channel](https://join.slack.com/t/documenso/shared_invite/zt-1qwxxsvli-nDyojjt~wakhgBGl9JRl2w) for any questions and getting to know to other community members - ⭐ the repository to help us raise awareness -- Fix or create [issues](https://github.com/documenso/documenso/issues), that are needed for the first production release - Spread the word on Twitter, that Documenso is working towards a more open signing tool +- Fix or create [issues](https://github.com/documenso/documenso/issues), that are needed for the first production release + +## Contributing +- To contribute please see our [contribution guide](https://github.com/documenso/documenso/blob/main/CONTRIBUTING.md) ## Tools @@ -72,7 +74,15 @@ To run Documenso locally you need Follow these steps to setup documenso on you local machnine: -- Clone the repo: git clone https://github.com/documenso/documenso +- [Clone the repository](https://help.github.com/articles/cloning-a-repository/) it to your local device. + ```sh + git 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 npm i in root directory - Rename .env.example to .env - Set DATABASE_URL value in .env file