Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
94 lines (71 loc) · 2.78 KB

CONTRIBUTING.md

File metadata and controls

94 lines (71 loc) · 2.78 KB

🛠 Contributing to PriceScoutAI

🚀 Welcome, Developers & AI Enthusiasts!

Thank you for considering contributing to PriceScoutAI, an AI-powered price comparison tool. This guide will help you get started, whether you're fixing bugs, adding features, or optimizing AI models.

📌 How to Contribute

🔹 Step 1: Fork the Repository

  1. Go to PriceScoutAI GitHub Repo.
  2. Click Fork (top-right corner) to create your own copy.

🔹 Step 2: Clone the Repo Locally

git clone https://github.com/wizzardx/PriceScoutAI.git
cd PriceScoutAI

🔹 Step 3: Install Dependencies

Ensure you have Python 3.8+ installed. Then run:

pip install -r requirements.txt

🔹 Step 4: Create a New Branch

git checkout -b feature-branch-name

🔹 Step 5: Make Your Changes

  • Add or improve AI-powered retailer matching.
  • Enhance price scraping accuracy.
  • Optimize multi-currency conversion.
  • Improve TDD-based testing.

🔹 Step 6: Test Your Changes

Run unit tests before submitting:

pytest

🔹 Step 7: Commit & Push

git add .
git commit -m "Added new feature"
git push origin feature-branch-name

🔹 Step 8: Submit a Pull Request (PR)

  1. Go to your GitHub fork.
  2. Click Compare & Pull Request.
  3. Describe your changes and submit.

📈 Project Roadmap

✅ Short-Term Goals

  • Implement basic AI-driven price fetching.
  • Enhance retailer search reliability.
  • Add more web scraping sources.
  • Improve multi-currency price validation.

⏳ Long-Term Vision

  • 📡 Monetizable API Access – Paid API for businesses.
  • 📥 Price Drop Alerts – Subscription-based price notifications.
  • 📊 Price History Tracking – Visual analytics.
  • 📱 Mobile App – iOS/Android integration.

🔗 Technical Roadmap

For a detailed breakdown of ongoing tasks, see our TODO.md.

🔥 Future Revenue Models (Monetization Strategy)

💡 We're exploring the following monetization paths:

  • Premium API Access – Sell API keys for commercial use.
  • Subscription-Based Price Alerts – Notify users of price drops.
  • Browser Extension Add-On – Real-time price comparisons.
  • Partnerships & Affiliate Marketing – Retailer commissions.

🔍 Need Help?

For any issues or feature requests, open a GitHub Issue.

📬 Contact

🚀 Join us in building the future of AI-powered price scouting!