Welcome
Use the calendar below to book a time for our meeting. Please ensure you have the relevant project materials ready for discussion.
GitHub Project Setup Guide:
Follow these initial steps to set up your team for project collaboration on GitHub.
- Create a Private Repository
Log in to your GitHub account and navigate to the “Repositories” section.
Click the “New repository” button.
Provide a descriptive name for your repository that reflects your project.
Select the “Private” option to ensure your project’s code and files remain secure.
Click “Create repository”.
- Add Team Members (Optional) To grant teammates access to the code, add them as collaborators:
From your new repository, go to “Settings” > “Collaborators”.
Click “Add people”.
Enter the GitHub username of each team member.
Select the appropriate access level (e.g., “Write” for full access).
Click “Add username to this repository”.
Repeat this process for all team members.
- Add Me as a Collaborator To enable me to provide guidance and monitor progress, please add me as a collaborator.
GitHub Username: manoov.r@vit.ac.in
Access Level: “Write” access. This will allow me to review code, answer questions, and offer suggestions throughout the project.
- Synchronize with Your Team Using GitHub Issues Use GitHub Issues to break down your project, assign tasks, and track progress.
Create Issues: Break the project into manageable tasks. Each issue should have a clear title, description, and, if applicable, an assignee.
Use Task Lists: Within an issue description or comment, use Markdown to create checklists for breaking down complex tasks.
Assign and Track Tasks: Assign issues to specific team members and use labels (e.g., “bug,” “enhancement,” “in progress”) to categorize and visualize progress.
Collaborate: Use the comment section on each issue to discuss tasks, ask questions, and share updates.
- Organize Your Project with GitHub Projects It allows you to create kanban-style boards to organize tasks, track progress, and keep the entire team aligned.
Learn more: About GitHub Projects
Note:
- 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/
- Explore an optional step to learn about DevOps principles using GitHub Actions.
- Regularly pushing your project updates to the repository will ensure everyone stays on the same page and keeps the project moving forward.