fleetmind-dispatch-ai / TEAM_COLLABORATION_GUIDE.md
mashrur950's picture
Initial commit: FleetMind MCP with GitHub Actions auto-sync
d69447e
|
raw
history blame
7.77 kB

Team Collaboration Guide - MCP 1st Birthday Hackathon

Overview

This guide explains how to add team partners to your FleetMind MCP hackathon submission on Hugging Face Spaces.

Hackathon Details:


Method 1: Add Team Members via README Documentation (EASIEST)

For hackathon submission purposes, you MUST document your team in the Space's README.md file.

Steps:

  1. Edit the Team Section in README.md

    The Team section is already added to your README. Update it with your actual team information:

    ## πŸ‘₯ Team
    
    **Team Name:** FleetMind AI Team
    
    **Team Members:**
    - **John Doe** - [@johndoe](https://huggingface.co/johndoe) - Lead Developer & AI Architect
    - **Jane Smith** - [@janesmith](https://huggingface.co/janesmith) - Database Engineer
    - **Alex Chen** - [@alexchen](https://huggingface.co/alexchen) - UI/UX Developer
    
  2. Replace Placeholders:

    • [Your Team Name] β†’ Your actual team name
    • [Your Name] β†’ Team member's real name
    • @your-hf-username β†’ Their Hugging Face username
    • [Role] β†’ Their role in the project
  3. Commit and Push:

    cd F:\fleetmind-mcp\fleetmind-dispatch-ai
    git add README.md
    git commit -m "Update team member information"
    git push
    

Method 2: Grant Git Access to Team Partners (TECHNICAL COLLABORATION)

If your team partners need to push code directly to the Space, they need Git access.

Option A: Via Organization Membership

Since your Space is owned by the MCP-1st-Birthday organization, team members can:

  1. Join the Organization:

  2. Verify Access:

    • Once approved, they'll automatically have access based on organization permissions
    • Organization members with "write" or "contributor" roles can collaborate

Option B: Direct Collaborator Access

If you have admin rights to your Space:

  1. Go to Space Settings:

  2. Add Collaborators by Username:

    • Enter their Hugging Face username
    • Set their permission level (read/write/admin)
    • Send invitation

Method 3: Collaborate via Pull Requests (SAFEST)

Team members can contribute without direct write access using Pull Requests.

Steps:

  1. Team Partner Forks/Duplicates the Space:

    • They go to your Space page
    • Click the three dots (top right) β†’ "Duplicate this Space"
    • Make changes in their forked version
  2. Create Pull Request:

    • After making changes, they create a Pull Request
    • You review and merge their changes
  3. Enable Pull Requests:

    • Go to Space Settings
    • Ensure "Pull Requests" are enabled

Method 4: Share Git Credentials (NOT RECOMMENDED)

While technically possible, sharing your Git credentials is NOT recommended for security reasons. Use Methods 1-3 instead.


Technical Setup for Team Partners

Once your team partners have access, they need to set up their local environment:

1. Clone the Space

# Navigate to desired directory
cd F:\

# Clone the Space
git clone https://huggingface.co/spaces/MCP-1st-Birthday/fleetmind-dispatch-ai

# Enter directory
cd fleetmind-dispatch-ai

2. Authenticate with Hugging Face

They need a Hugging Face access token:

  1. Get Token:

  2. Login via CLI:

    # Install Hugging Face CLI
    pip install huggingface_hub
    
    # Login (they'll be prompted for token)
    huggingface-cli login
    
  3. Or Configure Git Credentials:

    git config credential.helper store
    

    When they push for the first time, Git will ask for:

    • Username: Their HF username
    • Password: Their HF access token (NOT their account password)

3. Make Changes and Push

# Make changes to files
# ...

# Stage changes
git add .

# Commit
git commit -m "Add feature X"

# Push to Space
git push

Hugging Face Spaces Access Levels

Understanding permission levels helps you decide what access to grant:

Role Can View Can Clone Can Push Can Manage Settings
Public βœ… βœ… ❌ ❌
Read βœ… βœ… ❌ ❌
Contributor βœ… βœ… Via PR only ❌
Write βœ… βœ… βœ… ❌
Admin βœ… βœ… βœ… βœ…

Hackathon Submission Requirements

For your team submission to be valid, ensure:

Required in README.md:

  • βœ… Team section with all member names and HF usernames
  • βœ… Track tag: mcp-in-action-track-01 (already added)
  • βœ… Demo video link (1-5 minutes) - TODO
  • βœ… Social media post link - TODO

Required in Space:

  • βœ… Published as a Space in MCP-1st-Birthday organization
  • βœ… App.py entry point (already created)
  • βœ… Working Gradio interface
  • βœ… All code created during hackathon period (Nov 14-30, 2025)

Troubleshooting

"Permission denied" when team partner tries to push

Solution:

  1. Verify they're added as collaborators with write access
  2. Check they're using the correct HF access token (not account password)
  3. Ensure token has "write" permissions

"Repository not found" error

Solution:

  1. Verify the Space URL is correct
  2. Check they have at least "read" access
  3. Ensure they're logged in: huggingface-cli whoami

Team member can't see the Space

Solution:

  1. If Space is private, add them as collaborators
  2. If Space is public (recommended for hackathon), they should see it
  3. Check organization membership status

Best Practices for Team Collaboration

  1. Communication:

    • Use Discord channel: agents-mcp-hackathon-winter25
    • Create a team group chat
    • Document decisions in README
  2. Code Management:

    • Pull before making changes: git pull
    • Commit frequently with clear messages
    • Test locally before pushing
  3. Task Distribution:

    • Assign specific files/features to team members
    • Avoid editing the same files simultaneously
    • Use TODO comments in code
  4. Version Control:

    • Create branches for major features (optional)
    • Use descriptive commit messages
    • Review each other's code

Quick Reference Commands

# Clone the Space
git clone https://huggingface.co/spaces/MCP-1st-Birthday/fleetmind-dispatch-ai

# Check current status
git status

# Pull latest changes
git pull

# Add all changes
git add .

# Commit with message
git commit -m "Description of changes"

# Push to Space
git push

# Check who you're logged in as
huggingface-cli whoami

# Login to HF
huggingface-cli login

Support & Resources


Timeline Reminder

  • Start Date: November 14, 2025
  • Submission Deadline: November 30, 2025 (11:59 PM UTC)
  • Days Remaining: Check dashboard regularly

Make sure all team members are added to README.md before the deadline!


Good luck with your hackathon submission! πŸš€