From 3603cdab0d8bd1f755f3623fb3e16cd9bf901538 Mon Sep 17 00:00:00 2001
From: Sumanth U <157620444+Sumanth077s@users.noreply.github.com>
Date: Tue, 15 Oct 2024 17:20:42 +0530
Subject: [PATCH] Update Contributing.md
---
Contributing.md | 105 ++++++++++++++++++++++++++----------------------
1 file changed, 58 insertions(+), 47 deletions(-)
diff --git a/Contributing.md b/Contributing.md
index 8ae03bc..c2ca6af 100644
--- a/Contributing.md
+++ b/Contributing.md
@@ -1,62 +1,73 @@
-
+
Contributing to QR Code Generator Repository
-
-Thank you for your interest in contributing to **QR Code Generator**! We’re excited to see what creative ideas you bring. Follow these simple guidelines below to get started.
+
+ Thank you for your interest in contributing to QR Code Generator! We’re excited to see what creative ideas you bring.
+ Follow these simple guidelines below to get started.
+
---
## 🚀 Getting Started
1. **Fork the Repository**
- Click the "Fork" button at the top-right corner to create your own copy of the repo.
+ Click the **"Fork"** button in the top-right corner to create your own copy of the repo.
2. **Clone Your Fork**
Clone your forked repository to your local machine:
```bash
git clone https://github.com//qr-code-generator.git
- ```
-
-3. **Create a New Branch**
- Create a new branch for your changes:
- ```bash
- git checkout -b feature/your-feature-name
- ```
-
----
-
-## 🖌️ Making Changes
-
-1. **Code Changes**
- Make your modifications, ensuring they align with the project’s coding standards and code of conduct. Add exciting features, enriching documentation or squash bugs!
-
-2. **Commit Your Changes**
- Write meaningful commit messages:
- ```bash
- git commit -m "Add: New navigation bar feature"
- ```
-
-3. **Push Your Changes**
- Push your changes to your forked repository:
- ```bash
- git push origin feature/your-feature-name
- ```
-
----
-
-## 🛠️ Creating a Pull Request
-
-1. Once your changes are pushed, create a pull request (PR) on the original repository.
-2. Provide a detailed description of your changes and link any relevant issues. Provide relevant images/videos, if any.
-3. Wait for reviews and engage with feedback!
-
----
-
-## 🎉 Additional Notes
-
-- Make sure to sync your fork with the latest changes from the original repo before pushing new features.
-- Respect coding conventions and keep your code clean. Comment your changes for ease in review.
-
-Welcome to Open-Source and thank you for contributing! 🙌
\ No newline at end of file
+Sync with the Original Repository
+Keep your fork updated by syncing with the original repo:
+
+bash
+Copy code
+git remote add upstream https://github.com/original-owner/qr-code-generator.git
+git fetch upstream
+git merge upstream/main
+Create a New Branch
+Create a branch for your changes:
+
+bash
+Copy code
+git checkout -b feature/your-feature-name
+🖌️ Making Changes
+Code Changes
+Ensure your modifications align with the project’s coding standards and code of conduct. Add features, enrich documentation, or fix bugs! If you're adding or modifying functionality, consider adding tests to ensure it works correctly.
+
+Commit Your Changes
+Write meaningful and concise commit messages:
+
+bash
+Copy code
+git commit -m "Add: New navigation bar feature"
+If fixing a bug or issue, reference it in the commit:
+
+bash
+Copy code
+git commit -m "Fix: Issue #12 - Broken download button"
+Test Your Changes
+Run the project’s tests before committing:
+
+bash
+Copy code
+npm test
+Push Your Changes
+Push your changes to your forked repository:
+
+bash
+Copy code
+git push origin feature/your-feature-name
+🛠️ Creating a Pull Request
+Open a Pull Request (PR) on the original repository by clicking "New Pull Request".
+Provide a detailed description of your changes and explain their purpose. If applicable, link any relevant issues (e.g., “Fixes #12”).
+Include screenshots, GIFs, or videos demonstrating new features or bug fixes.
+Respond to Feedback: Be open to feedback from reviewers and maintainers. If requested, make the necessary adjustments and update your PR.
+🎉 Additional Notes
+Sync Your Fork Regularly: Ensure your fork is up to date with the original repo before starting new work.
+Follow Coding Standards: Keep your code clean, readable, and well-commented for easier reviews.
+Make Focused PRs: Submit small, focused PRs to make the review process smoother.
+Be Respectful and Collaborative: Follow the project’s code of conduct and engage positively with the community.
+Welcome to Open-Source, and thank you for contributing! 🙌
```