Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
198 lines (127 loc) · 2.87 KB

CONTRIBUTING.md

File metadata and controls

198 lines (127 loc) · 2.87 KB

Contributing to VishwaGuru 🌟

Thank you for your interest in contributing to VishwaGuru!
This guide will help you set up the project locally and contribute effectively.

📋 Getting Started

🔹 Prerequisites

Ensure you have the following installed:

  • Python 3.12+
  • Node.js 20+ and npm
  • Git
  • Telegram Bot Token (from @BotFather)
  • Google Gemini API Key

⚙️ Setup Development Environment

1. Fork and Clone the Repository

Fork the repository from GitHub and clone it locally.

git clone https://github.com/YOUR_USERNAME/VishwaGuru.git
cd VishwaGuru

2. Add Upstream Repository

Add the main repository as upstream to keep your fork updated.

git remote add upstream https://github.com/RohanExploit/VishwaGuru.git
git fetch upstream

3. Create and Activate Virtual Environment

Create a Python virtual environment and activate it.

python -m venv venv

Windows

venv\Scripts\activate

Linux/Mac

source venv/bin/activate

4. Install Backend Dependencies

Install required Python packages.

pip install -r requirements.txt

5. Install Frontend Dependencies

Install required Node.js packages.

npm install

6. Environment Variables Setup

Create a .env file in the root directory and add your API keys.

⚠️ Never commit your .env file.

TELEGRAM_BOT_TOKEN=your_telegram_bot_token_here
GEMINI_API_KEY=your_gemini_api_key_here

▶️ Run the Project

Run backend and frontend services.

Backend

python main.py

Frontend

npm run dev

🌱 Creating a New Branch

Create a new branch before starting work.

git checkout -b feature/your-feature-name

🧪 Testing

Test your changes before pushing.

📦 Commit Guidelines

Use meaningful commit messages.

Examples:

  • feat: add chatbot UI
  • fix: resolve telegram webhook bug
  • docs: update contributing guide
git commit -m "feat: add Gemini API integration"

🔁 Sync with Upstream

Keep your fork updated before opening a PR.

git fetch upstream
git merge upstream/main

🚀 Pull Request Process

  1. Push your branch to your fork.
  2. Open a Pull Request against main branch.
  3. Describe your changes clearly.
  4. Attach screenshots if UI changes are made.
git push origin feature/your-feature-name

🐛 Reporting Issues

Include:

  • Steps to reproduce
  • Expected behavior
  • Actual behavior
  • Screenshots or logs

📚 Code Style Guidelines

  • Follow PEP8 for Python
  • Write clean and readable code
  • Add comments for complex logic
  • Use meaningful variable names

🤝 Code of Conduct

Be respectful and welcoming to all contributors.

💡 Need Help?

Open an issue or discussion here:
https://github.com/RohanExploit/VishwaGuru