Skip to content

Latest commit

 

History

History
111 lines (84 loc) · 2.76 KB

CONTRIBUTING.md

File metadata and controls

111 lines (84 loc) · 2.76 KB

Contributing Guidelines

Thank you for your interest in contributing to WhatsApp Facilitator Google Suite Integration! 🎉
We appreciate your time and effort in improving this project. Please follow the guidelines below to ensure smooth collaboration.

📌 How to Contribute

1️⃣ Fork the Repository

Click the Fork button on the top right of the repository page to create your copy.

2️⃣ Clone Your Fork

git clone https://github.com/arya2004/facilitator.git
cd facilitator

3️⃣ Create a Branch

Create a new branch for your changes:

git checkout -b feature-name
  • Use meaningful branch names (e.g., fix-calendar-bug, add-folder-allocation).

4️⃣ Make Your Changes

  • Ensure your code follows best practices and is well-documented.
  • For AI-related modifications, ensure proper prompt structuring and testing.
  • For Google API integrations, ensure compliance with Google’s API guidelines.
  • Run tests before committing your changes.

5️⃣ Commit Changes

git add .
git commit -m "Brief description of changes"

Follow commit message conventions: ✅ Good: fix: resolve Google Calendar API bad request issue
❌ Bad: Fixed something

6️⃣ Push to Your Fork

git push origin feature-name

7️⃣ Open a Pull Request (PR)

  • Go to the original repository.
  • Click New Pull Request.
  • Select your branch and add a clear title & description.
  • Mention related issue numbers (if applicable).

🛠 Contribution Guidelines

✅ Do's:

✔️ Follow the project structure and naming conventions.
✔️ Write clear, modular, and maintainable code.
✔️ Use logging instead of print statements.
✔️ Test your changes before pushing.
✔️ Provide detailed PR descriptions.

🚫 Don'ts:

❌ Commit secrets or API keys.
❌ Make changes directly to the main branch.
❌ Push broken or untested code.

💡 Contribution Areas

You can contribute by:

  • Fixing bugs 🐞
  • Improving AI message parsing 🤖
  • Enhancing Google Suite integrations 📅
  • Optimizing performance ⚡
  • Adding new features ✨
  • Improving documentation 📄

🔧 Development Setup

Prerequisites

  • Python 3.x
  • Install dependencies: 
    pip install -r requirements.txt
  • Set up your .env file (see README for details).

Running the Project

python run.py

🤝 Code of Conduct

Be respectful, collaborative, and constructive. See our Code of Conduct for details.

🔗 Need Help?

For any questions, feel free to:

Happy coding! 🚀🎯