Skip to content

Latest commit

 

History

History
105 lines (81 loc) · 3.14 KB

CONTRIBUTING.md

File metadata and controls

105 lines (81 loc) · 3.14 KB

📜 Contribution Guidelines

Thank you for your interest in contributing to the AI-Powered E-commerce SaaS project! We welcome contributions from developers, designers, and eCommerce enthusiasts. This guide outlines the best practices for contributing effectively.

🚀 How to Contribute

1️⃣ Fork & Clone the Repository

  1. Click Fork at the top right of the repository page.
  2. Clone your fork: 
    git clone https://github.com/your-username/AI-Ecommerce-SaaS.git
cd frontend, or
cd backend
  3. Set up the upstream repository to sync changes: 
    git remote add upstream https://github.com/original-repo/AI-Ecommerce-SaaS.git

2️⃣ Create a Feature Branch

Always create a new branch when making changes:

git checkout -b feature-name

Example:

git checkout -b feature-ai-pricing

3️⃣ Make Your Changes

✅ Follow coding standards (ESLint, Prettier for JS; PEP8 for Python).
✅ Keep PRs focused on a single feature or fix.
✅ Document your changes in README.md or relevant files.

4️⃣ Commit & Push Your Changes

Commit with a clear message:

git add .
git commit -m "✨ Added AI-Powered Pricing Engine"
git push origin feature-name

5️⃣ Open a Pull Request (PR)

  1. Go to GitHub > Your Fork > Pull Requests.
  2. Click “New Pull Request”.
  3. Select base branch (main) and compare branch (feature-name).
  4. Provide a descriptive title and summary: 
    ## Summary
- Implemented AI-powered pricing algorithm.
- Optimized API calls for real-time updates.
- Improved error handling for price adjustments.
  5. Click Create Pull Request.

6️⃣ Review & Merge

🔹 Wait for a maintainer’s review.
🔹 If changes are requested, make updates and push again:

git push origin feature-name

🔹 Once approved, the PR will be merged into main.

✅ Best Practices

  • Write clean, modular code with meaningful variable names.
  • Add comments where needed to explain complex logic.
  • Keep commits small & focused on a single feature or fix.
  • Use descriptive commit messages following Conventional Commits.
  • Run tests before pushing to ensure stability.

🐛 Reporting Bugs & Feature Requests

1️⃣ Submitting a Bug Report

  • Open a GitHub Issue using the “Bug Report” template.
  • Provide steps to reproduce, expected vs. actual behavior, and screenshots.

2️⃣ Requesting a Feature

  • Open a GitHub Discussion or Feature Request Issue.
  • Explain why this feature is valuable and how it should work.

🌎 Community & Support

💬 Join the Discussion: GitHub Discussions
📢 Join Our Facebook Group: Siberlink | AI SaaS Developers
📩 Join Our Discord: Discord Invite

🚀 Thank you for contributing! Let’s build the future of AI-powered eCommerce together!