Project Collaboration using GitHub

Jul 15, 2024

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

  1. Create a Private Repository Go to your GitHub account and navigate to the “Repositories” section. Click on the “New repository” button. Give your repository a descriptive name that reflects your project. Select the “Private” option to keep your project code and files secure. Click on “Create repository”.
  2. Add Team Members (Optional) If you have team members working on the project with you, you can add them to your repository to grant them access to the code.

In your repository settings, navigate to the “Collaborators” section. Enter the username of your team member. Select the access level you want to grant them (e.g., “Write” for full access). Click on “Invite collaborator”. Repeat this process for all your team members.

  1. Add me as a Collaborator To provide guidance and monitor your project progress, please add me (GitHub Username: manoov.r@vit.ac.in) as a collaborator on your repository with “Write” access. This will allow me to review your code, documentation, answer questions, and offer suggestions.

  2. Synchronizing with Team and Setting Goals using GitHub Issues:

Create Issues: Break down your project into smaller, manageable tasks using GitHub Issues. Each issue should have a clear title, description, and assignee (if applicable).

Utilize Task Lists: Within each issue, you can create a task list using Markdown. This allows you to further break down complex tasks into smaller, actionable steps.

Assign and Track Tasks: Assign tasks to specific team members and use labels to categorize them (e.g., “Bug,” “In Progress,” “To Do”). This helps visualize the overall project progress and individual responsibilities.

Discussion and Collaboration: Use the comment section within each issue to discuss tasks, ask questions, and share updates with your team.

  1. Learn About GitHub Projects For effective collaboration and project management, ‘GitHub Projects’ is highly recommended. It allows you to create boards, organize tasks, track progress, and share updates with your team.

Learn more about GitHub Projects:

Link: https://docs.github.com/en/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects

Note:

  1. Decide how you and your team will share information and ideas. Options include using a note-taking app like (Zettlr, Obsidian) or a reference management tool like Mendeley (useful for research projects). Sync Your Obsidian Vault for Free with Github: https://curtismchale.ca/2022/05/18/sync-your-obsidian-vault-for-free-with-github/
  2. Explore an optional step to learn about DevOps principles using GitHub Actions.
  3. Regularly pushing your project updates to the repository will ensure everyone stays on the same page and keeps the project moving forward.