From 2ed4cb636b9cff2b6266d0f3eec396811812b7ea Mon Sep 17 00:00:00 2001
From: Catalin Pit <25515812+catalinpit@users.noreply.github.com>
Date: Mon, 22 Apr 2024 12:03:45 +0300
Subject: [PATCH] chore: improved contributing copy

---
 .../pages/contributing/index.mdx              | 68 ++++++++++++-------
 1 file changed, 43 insertions(+), 25 deletions(-)

diff --git a/apps/documentation/pages/contributing/index.mdx b/apps/documentation/pages/contributing/index.mdx
index c1a6a17b8..f263f21ce 100644
--- a/apps/documentation/pages/contributing/index.mdx
+++ b/apps/documentation/pages/contributing/index.mdx
@@ -5,55 +5,73 @@ description: Set up Documenso using Docker for local development.
 
 # 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.
+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 🙏. This guide will help you get started with contributing to Documenso 💻.
 
 ## 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 an issue from [here](https://github.com/documenso/documenso/issues) or create a new one
-- Consider the results from the discussion on the issue
+- Search the existing [issues](https://github.com/documenso/documenso/issues) to see if someone else reported the same issue. Or, check the [existing PRs](https://github.com/documenso/documenso/pulls) to see if someone else is already working on the same thing.
+- If there is no issue or PR for the problem you are facing, feel free to create a new issue. Make sure to provide as much detail as possible, including the steps to reproduce the issue.
+- If you pick an existing issue, take into consideration the discussion on the issue.
 - Accept the [Contributor License Agreement](https://documen.so/cla) to ensure we can accept your contributions.
 
 ## Taking issues
 
 Before taking an issue, ensure that:
 
-- The issue has been assigned the public label
-- The issue is clearly defined and understood
-- No one has been assigned to the issue
-- No one has expressed intention to work on it
+- The issue has been assigned the public label.
+- The issue is clearly defined and understood.
+- No one has been assigned to the issue.
+- No one has expressed the intention to work on it.
 
-You can then:
+After that:
 
-1. Comment on the issue with your intention to work on it
-2. Begin work on the issue
+1. Comment on the issue with your intention to work on it.
+2. Start working on the issue.
 
-Always feel free to ask questions or seek clarification on the issue.
+Feel free to ask for help, clarification or guidance if needed. We are here to help you.
 
 ## Developing
 
-The development branch is <code>main</code>. All pull requests should be made against this branch. If you need help getting started, [join us on Discord](https://documen.so/discord).
+The development branch is <code>main</code>, and all pull requests should be made against this branch. Here's how you can get started with developing:
 
-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:
+1. Fork the repository to your GitHub account and then
+   clone it to your local device.
 
-- Create a new branch (include the issue id and something readable):
+2. Check out the [local development](/local-development) guide to set up your local environment.
 
-  ```sh
-  git checkout -b feat/doc-999-somefeature-that-rocks
-  ```
+3. Find an issue to work on or create a new one.
 
-3. See the [Developer Setup](https://github.com/documenso/documenso/blob/main/README.md#developer-setup) for more setup details.
+4. Create a new branch for your feature or bug fix.
+
+When creating a branch, make sure that the branch name:
+
+- starts with the correct prefix: `feat/` for new features, `fix/` for bug fixes, etc.
+- includes the issue id you are working on (if applicable).
+- is descriptive.
+
+```sh
+git checkout -b feat/issue-id-your-branch-name
+
+## Example
+git checkout -b feat/1234-add-share-button-to-articles
+```
+
+In the pull request description, include `references #yyyy` or `fixes #yyyy` to link it to the issue you are working on.
+
+4. Implement your changes.
+
+> If you need help getting started, [join us on Discord](https://documen.so/discord).
 
 ## Building
 
-> **Note**
-> Please ensure you can make a full production build before pushing code or creating PRs.
+Before pushing code or creating pull requests, please ensure you can successfully create a successful production build.
 
-You can build the project with:
+You can build the project by running the following command in your terminal:
 
 ```bash
 npm run build
 ```
+
+Once the project builds successfully, you can push your code changes or create a pull request.
+
+> Remember to run tests and perform any necessary checks before finalizing your changes. By following these best practices, we can collaborate more effectively and maintain a high standard of code quality in our project.