Merge pull request #91 from SardulR/main

Create CONTRIBUTING.md

CONTRIBUTING.md

@@ -0,0 +1,68 @@
+# **Contributing Guidelines** 📄
+
+This documentation contains a set of guidelines to help you during the contribution process.
+We are happy to welcome all the contributions from anyone willing to improve/add new scripts to this project.
+Thank you for helping out and remember, **no contribution is too small.**
+<br>
+Please note we have a [code of conduct](CODE_OF_CONDUCT.md)  please follow it in all your interactions with the project.
+
+
+
+<br>
+
+## **Need some help regarding the basics?🤔**
+
+
+You can refer to the following articles on basics of Git and Github and also contact the Project Mentors,
+in case you are stuck:
+
+- [Forking a Repo](https://help.github.com/en/github/getting-started-with-github/fork-a-repo)
+- [Cloning a Repo](https://help.github.com/en/desktop/contributing-to-projects/creating-an-issue-or-pull-request)
+- [How to create a Pull Request](https://opensource.com/article/19/7/create-pull-request-github)
+- [Getting started with Git and GitHub](https://towardsdatascience.com/getting-started-with-git-and-github-6fcd0f2d4ac6)
+- [Learn GitHub from Scratch](https://docs.github.com/en/get-started/start-your-journey/git-and-github-learning-resources)
+
+<br>
+
+## **Issue Report Process 📌**
+
+1. Go to the project's issues.
+2. Give proper description for the issues.
+3. Don't spam to get the assignment of the issue 😀.
+4. Wait for till someone is looking into it !.
+5. Start working on issue only after you got assigned that issue 🚀.
+
+<br>
+
+## Set-Up and Installation:
+
+To get started with Rubik Cube, follow these simple steps:
+
+1. Clone the repository: To get started with contributing to our project, fork the repository and then clone it to your local machine
+   ```bash
+   git clone https://github.com/your-username/Rubik-Cube.git
+
+2. Change the directory to Client and Install required Packages
+     ```bash
+      cd client
+      npm install
+   ```
+3. Make Your Changes: Make the necessary modifications or additions to the project files.
+
+4. Commit and Push Once you've made your changes, commit them and push to your fork:
+   ```bash
+    git add .
+    git commit -m "Describe your changes here"
+    git push
+   ```
+5. Create a Pull Request:
+   Navigate back to the original repository and open a pull request from your forked repository.
+## **Pull Request Process 🚀**
+1. Ensure that you have self reviewed your code 😀
+2. Make sure you have added the proper description for the functionality of the code
+3. I have commented my code, particularly in hard-to-understand areas.
+4. Add screenshot it help in review.
+5. Submit your PR by giving the necesarry information in PR template and hang tight we will review it really soon 🚀
+<br>
+# **Thank you for contributing💗** 
+Footer