Skip to content
This repository was archived by the owner on Jul 17, 2025. It is now read-only.

Contributing Guide

SUGGESTIED ✨ edited this page Feb 5, 2025 · 1 revision

🛠️ Contributing Guide - OpenWardrobe

Thank you for your interest in contributing to OpenWardrobe! 🚀 We welcome all contributions, whether you're fixing bugs, adding features, or improving documentation. Please follow this guide to ensure a smooth collaboration.


📌 How to Fork & Clone the Repo

1️⃣ Fork the Repository

  1. Navigate to the [OpenWardrobe GitHub Repository](https://github.com/suggestied/openwardrobe).
  2. Click the "Fork" button in the top-right corner.

2️⃣ Clone Your Own Fork Locally

Once you’ve forked the repo, clone it to your machine:

# Replace YOUR-GITHUB-USERNAME with your actual GitHub username
git clone https://github.com/YOUR-GITHUB-USERNAME/openwardrobe.git
cd openwardrobe

🌱 How to Create a Feature Branch

  1. Ensure you're on the latest main branch:
    git checkout main
    git pull origin main
  2. Create a new branch for your feature or bug fix:
    git checkout -b feature-new-outfit-planner
  3. Make your changes in the code.
  4. Stage and commit your changes:
    git add .
    git commit -m "✨ Added new outfit planner feature"
  5. Push your branch to your forked repository:
    git push origin feature-new-outfit-planner

📩 How to Submit a Pull Request (PR)

  1. Go to your forked repository on GitHub.
  2. Click "Compare & pull request" next to your pushed branch.
  3. Ensure the PR is being merged into the main branch.
  4. Add a clear description of your changes.
  5. Click "Create pull request".
  6. Wait for review & feedback from maintainers! 🎉

📜 Code Formatting Guidelines

Before submitting a PR, ensure your code follows our formatting and style guide.

1️⃣ Format Your Code

Run the official Dart formatter:

flutter format .

2️⃣ Run Static Analysis

flutter analyze

3️⃣ Run Tests

flutter test

🛡️ Reporting Issues & Feature Requests


💪 Join the Community


✨ Ready to Start?

[Fork the Repo & Start Contributing!](https://github.com/suggestied/openwardrobe/fork)

Thank you for helping make OpenWardrobe better! 💖