From 1fa3a71ab28fd6ac87cd2166f48a13cf6a5b36b7 Mon Sep 17 00:00:00 2001
From: Usman Khan <44539272+kha333n@users.noreply.github.com>
Date: Sat, 13 Jul 2024 18:24:20 +0500
Subject: [PATCH] Create CONTRIBUTING.md

---
 CONTRIBUTING.md | 65 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 65 insertions(+)
 create mode 100644 CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..23e75ed
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,65 @@
+# Contributing to crudmodule
+
+Thank you for considering contributing to crudmodule! We welcome contributions of all kinds: new features, bug fixes, documentation improvements, and more.
+
+## Getting Started
+
+### 1. Fork the Repository
+
+Fork the repository by clicking the "Fork" button on the top right of the repository page.
+
+### 2. Clone the Repository
+
+Clone your forked repository to your local machine:
+
+```sh
+git clone https://github.com/kha333n/crudmodule.git
+cd crudmodule
+```
+
+### 3. Check Out the dev Branch
+Check out the dev branch and pull the latest changes:
+
+```sh
+git checkout dev
+git pull upstream dev
+```
+
+### 4. Making Changes
+Create a new branch for your feature or bug fix:
+
+```sh
+git checkout -b feature-or-bugfix-name
+```
+### 5. Make Your Changes
+Make your changes in the new branch. Be sure to follow the project's coding standards and include appropriate tests.
+
+### 6. Commit Your Changes
+Commit your changes with a descriptive commit message:
+
+```sh
+git add .
+git commit -m "Description of changes"
+```
+
+### 7. Push Your Changes
+Push your changes to your forked repository:
+
+```sh
+git push origin feature-or-bugfix-name
+```
+### 8. Create a Pull Request
+Go to the original repository and click on the "New Pull Request" button. Select your branch from the list of branches and click "Create Pull Request". Provide a descriptive title and a detailed description of your changes.
+
+### Code Review Process
+All pull requests will be reviewed by the maintainers. Here are some guidelines to follow:
+
+* Ensure your code follows the project's coding standards.
+* Provide a detailed description of your changes.
+* Address any feedback from the maintainers promptly.
+* Additional Notes
+* Please create pull requests to the dev branch, not the master branch.
+* Keep your pull requests focused on a single issue or feature. Large pull requests are difficult to review.
+* Ensure that your branch is up to date with the latest changes from dev before creating a pull request.
+
+Thank you for your contributions!