From db0204d81bddd9892a5bfdfa14ce9c460fc353b0 Mon Sep 17 00:00:00 2001
From: archanasingh11 <archanasingh11702@gmail.com>
Date: Wed, 2 Oct 2024 16:49:51 +0530
Subject: [PATCH] updated contributing.md

---
 Contributing.md | 91 +++++++++++++++++++++++++++++++++++++++++++++++++
 README.md       |  2 ++
 2 files changed, 93 insertions(+)
 create mode 100644 Contributing.md

diff --git a/Contributing.md b/Contributing.md
new file mode 100644
index 00000000..56e2cef7
--- /dev/null
+++ b/Contributing.md
@@ -0,0 +1,91 @@
+# Contributing to Retro
+
+We’re excited that you want to contribute to Retro! The following is a set of guidelines to help you contribute effectively and ensure consistency within the project.
+
+## How to Contribute
+
+### 1. Fork the Repository
+Click on the "Fork" button at the top of the repository’s GitHub page. This will create a copy of the repository in your GitHub account.
+
+### 2. Clone the Forked Repository
+Clone the forked repository to your local machine using the command below:
+
+```bash
+git clone https://github.com/<your-github-username>/Retro
+```
+
+### 3. Add Remote Upstream
+Add a remote upstream to keep your fork updated with the original repository:
+
+```bash
+git remote add upstream https://github.com/original-owner-username/Retro
+```
+
+### 4. Create a New Branch
+Before making changes, create a new branch for your work:
+
+```bash
+git checkout -b <your-branch-name>
+```
+
+### 5. Make Your Changes
+Make the necessary changes to the codebase.
+
+### 6. Stage Your Changes
+Once you’ve made your changes, stage them for commit:
+
+```bash
+git add <file1> <file2> ...
+```
+
+### 7. Commit Your Changes
+Commit your changes with a descriptive message:
+
+```bash
+git commit -m "A meaningful message describing the change"
+```
+
+### 8. Push Your Changes
+Push your changes to your forked repository:
+
+```bash
+git push origin <your-branch-name>
+```
+
+### 9. Create a Pull Request (PR)
+Go to your forked repository on GitHub. You should see a prompt to create a pull request. Compare the changes and create the PR. Ensure to fill in details about the changes you’ve made.
+
+---
+
+## Guidelines
+
+### Reporting Bugs
+If you encounter any bugs, feel free to report them. Please ensure you include:
+- A clear and descriptive title.
+- A description of the issue and how to reproduce it.
+- Expected behavior vs. actual behavior.
+- Any error messages or logs that might help.
+
+### Suggesting Features or Enhancements
+We welcome new ideas and suggestions! To propose a new feature:
+- Open an issue with a feature request label.
+- Provide a clear description of the feature and how it improves the project.
+
+### Submitting Code
+- Keep your pull requests focused on a single change to make reviews easier.
+- Follow the project’s code style.
+- Ensure your code is properly tested before submitting.
+
+### Commit Message Format
+- Use meaningful and descriptive commit messages.
+- Use the imperative mood (e.g., "Add feature" instead of "Added feature").
+
+## Development Setup
+
+To set up a local development environment:
+1. Fork and clone the repository (as mentioned above).
+2. Follow the installation steps in the README to get the project running locally.
+
+---
+
+Thank you for contributing to Retro! We appreciate your time and effort in helping us improve the project.
diff --git a/README.md b/README.md
index 4f5ffd0b..6b965160 100644
--- a/README.md
+++ b/README.md
@@ -101,6 +101,8 @@ To contribute to the Retro repository using GitHub Desktop, follow these steps:
 <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Objects/Axe.png" width="20" height="20" >Submitting a fix<br>
 <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/tarikul-islam-anik/main/assets/images/Rocket.png" width="20" height="20" >Proposing new features
 
+To get started with contributing, please follow the steps outlined in the [Contributing.md](Contributing.md).
+
 <div align="center">
   <h2 style="font-size:3rem;">Our Contributors <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Smilies/Red%20Heart.png" alt="Red Heart" width="40" height="40" /></h2>
   <h3>Thank you for contributing to our repository</h3>