Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
96 lines (60 loc) · 1.76 KB

CONTRIBUTING.md

File metadata and controls

96 lines (60 loc) · 1.76 KB

🤝 Contributing to Dukan

Welcome! 🎉
Thank you for considering contributing to Dukan, an open-source full-stack e-commerce web app. We’re excited to build this with the community — your help is appreciated!

📋 How to Contribute

  1. Fork the repo

  2. Clone your fork

    git clone https://github.com/your-username/dukan-frontend.git
git clone https://github.com/your-username/dukan-backend.git

  3. Create a new branch

    git checkout -b feature/your-feature-name

  4. Make your changes

  5. Commit with a clear message

    git commit -m "✨ Add: [feature/bug description]"

  6. Push to your fork

    git push origin feature/your-feature-name

  7. Open a Pull Request from your branch to the main branch of the original repo.

💡 What Can You Work On?

We're looking for help with:

  • 🐛 Bug Fixes
  • ✨ New Features
  • 🎨 UI Improvements
  • 🧪 Unit & Integration Tests
  • 📚 Documentation
  • 🌍 Localization support

🧪 Project Setup

Frontend (Next.js)

cd dukan-frontend
npm install
npm run dev

Backend (Node.js/Express)

cd dukan-backend
npm install
npm run dev

Make sure to set your environment variables in .env files before running the apps.

📜 Code of Conduct

Please read our Code of Conduct before contributing. Respectful, inclusive behavior is expected from everyone.

🛡️ License

Dukan is open-sourced under the MIT License.

🙌 Let’s Build Together!

If you're new to open source, don’t worry! Feel free to open issues, ask questions, and make your first pull request. We welcome all contributions — big or small 💜