Skip to content

Latest commit

 

History

History
126 lines (94 loc) · 3.83 KB

CONTRIBUTING.md

File metadata and controls

126 lines (94 loc) · 3.83 KB

🚀 Contributing to QR Code app

Thank you for considering contributing to QR Code app! Your contributions are incredibly valuable and help us improve the product.

📑 Table of Contents

🏁 Getting Started

  1. 🍴 Fork the Repository: Click the “Fork” button at the top right of the repository page.

    https://github.com/chetanr25/qr_code.git

  2. 📂 Clone Your Fork:
    Replace your-username with your GitHub username.

    git clone https://github.com/<your-username>/qr_code.git
cd qr_code

  3. 📦 Install Dependencies:

    flutter pub get

💡 How to Contribute

🐛 Bug Reports

If you encounter a bug, please report it by creating an issue. Include detailed information to help us understand and reproduce the issue:

  • Steps to reproduce the bug.
  • Expected behavior.
  • Actual behavior.
  • Screenshots or logs, if applicable.

🌟 Feature Requests

We welcome new feature ideas! To request a feature, open an issue and provide:

  • A clear and descriptive title.
  • The motivation for the feature.
  • A detailed description of the proposed solution.
  • Any alternatives considered.

💻 Code Contributions

We appreciate code contributions! To contribute:

  1. 🌿 Create a Branch:

    git checkout -b feature/your-feature-name

  2. ⚙️ Make Changes:
    Implement your changes following the Development Guidelines.

  3. 📥 Commit Changes:

    git add .
git commit -m "Add feature: your feature name"

  4. 🚀 Push to Your Fork:

    git push origin feature/your-feature-name

🔄 Pull Request Process

  1. 🔗 Add the Original Repository as a Remote (Upstream)
    If you haven’t already added the original repository as a remote, run:

    git remote add upstream https://github.com/chetanr25/qr_code.git

  2. ⬇️ Fetch the Latest Changes from Upstream

    git fetch upstream

  3. 🔀 Merge the Latest Changes from Upstream/Main into Your Feature Branch

    git checkout feature/your-feature-name
git merge upstream/main

  4. 📤 Create a Pull Request
    After merging the latest changes, go to the original repository and open a Pull Request (PR). Provide a clear and descriptive title and a detailed explanation of your changes.

Development Guidelines

  • 🧹 Code Style: Follow the Dart Style Guide and Flutter conventions to maintain consistency.
  • 📝 Documentation: Update code comments and the README.md file as needed to reflect your changes.

📬 Contact

For questions or further assistance, feel free to reach out by opening an issue or contacting the maintainers directly.
Linktree LinkedIn Gmail

We appreciate your contributions and look forward to collaborating with you!