Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
70 lines (50 loc) · 2.73 KB

CONTRIBUTING.md

File metadata and controls

70 lines (50 loc) · 2.73 KB

Contributing to GoCart

Thank you for considering contributing to GoCart! We welcome contributions from everyone, whether it's fixing a bug, adding a new feature, or optimizing the codebase.

Table of Contents

How to Contribute

  1. Fork the repo
  2. Create a new branch (example: git checkout -b feature/added-about-page)
  3. Make your changes (UI, animations, pages, etc.)
  4. Commit and push
  5. Open a Pull Request (PR)

Development Setup

  • Use Next.js and Tailwind CSS
  • Run npm run dev for local development.
  • Keep code clean, modular and reusable
  • Prefer functional components and hooks
  • Follow existing folder structure and naming conventions

Contribution Guidelines

  • Small, Focused PRs → Don’t bundle unrelated changes in one PR
  • Commit Messages → Use clear and descriptive messages (e.g., feat: add new feature, fix: resolve issue #123).
  • Code Style → Follow the existing code style (e.g., indentation, naming conventions, etc.).
  • Accessibility → Ensure that the website is accessible to all users
  • Discussions First → For large changes (new features, big design changes), discuss the changes first to avoid wasting time on implementation.
  • Respect Others → Follow the Code of Conduct

Ideas for Contribution

Here are some areas where you can contribute:

Vendor-Specific Features:

  • Vendor Dashboard: Build or enhance pages for vendors to manage products, view sales analytics, and handle orders.
  • Product Management: Implement features for vendors to add, edit, and remove their products.
  • Vendor Onboarding: Create or improve the registration and verification process for new vendors.

Customer-Facing Features:

  • Product Discovery: Add advanced filtering and sorting options (e.g., by vendor, by rating).
  • Vendor Profiles: Create public-facing pages for each vendor to showcase their brand and products.
  • Shopping Cart & Checkout: Improve the cart functionality to handle products from multiple vendors.

General Improvements:

  • UI/UX: Suggest and implement new design ideas to improve user experience.
  • Performance: Optimize components and queries for faster load times.
  • Accessibility: Enhance accessibility across the platform.
  • Animations: Add subtle animations and transitions to make the UI more engaging.
  • Admin Panel: Develop features for platform administrators to manage vendors, products, and commissions.

We're excited to see your contributions! 🚀