Schedule a Meeting

Welcome

🗓️ Use the calendar below to book a time for our meeting. Please ensure you have the relevant project materials ready for discussion.

GitHub Workflow & Team Collaboration Guidelines:

📝 Follow these initial steps to set up your team for project collaboration on GitHub.

1️⃣ Initial Repository Setup

• All project repositories will be created and managed by the instructor to ensure proper access control and evaluation.

• Each student (or team) must email the following details:

  • Full Name
  • Register Number
  • GitHub Username
  • Email ID (linked to GitHub account)
  • Preferred repository name

📨 Send these details to: manoov.r [at] vit [dot] ac [dot] in

2️⃣ Task Management with GitHub Issues

▪️ Team members must choose a specific sub-topic or feature of the project they are interested in contributing to.

▪️ Team leader will create corresponding Issues for these sub-topics.

▪️ Each issue will be assigned to the respective team member. This acts as your central hub for ideation and task definition.

• Use Markdown checklists (- ) within issue descriptions to track progress on sub-tasks.

▪️ Use comments to collaborate and document decisions as you go.

3️⃣ Track Progress Visually with GitHub Projects

▫️ Project Integration: Link all Issues (including sub-issues) to a GitHub Project Board. GitHub Projects

▫️ Visualization: Use the Project’s customizable board (Kanban or Table view) to track the flow of work (To Do, In Progress, Review, Done).

4️⃣ Branching & PRs:

To ensure your contributions are tracked and graded, follow this incremental workflow for every task:

⚙️ Step-1: Update your local code/README.md Sync with Main Before starting, always pull the latest changes:

git checkout main
git pull origin main

⚙️ Step-2: Create a new branch. Never work directly on main. Create a branch for your specific task using descriptive names.

# Replace 'task-name' with your actual task
git checkout -b student-name/task-name

⚙️ Step-3: Save your work (Commit) - Incremental Commits As you work, save your progress with clear, descriptive messages. Small, frequent updates prevent “merge chaos.”

git add .
git commit -m "Brief description of what you changed"

⚙️ Step-4: Push your branch to GitHub

git push origin student-name/task-name

⚙️ Step-5: Pull Requests (PRs) & Review

Create a Pull Request (PR) - Go to your repository on GitHub.com.

- Open a Pull Request on GitHub.

- Link the Issue: In the PR description, write Closes #IssueNumber to link it to your task.

- Review Process: Either the Instructor or team leader will review the PR. Feedbacks must be addressed before the contribution is merged into the main repository.

- Commit and push regularly - don't save everything for last minute

📝 Tutorial: How To Use GitHub Branches & Pull Request

5️⃣ Grading checklist and Rubric

Optional-

✅ For deeper research and interconnected thinking, try using Obsidian with the Zettelkasten philosophy:

• Sync with GitHub for team collaboration: Obsidian Git Plugin

• Share an Obsidian vault as a team knowledge base though GitHub, all team notes become interconnected.

✅ Automate workflows with GitHub Actions (learn DevOps) GitHub Actions.