Software
Research Links
Software development using GitHub works by leveraging Git, a distributed version control system, hosted on a web-based platform that adds tools for collaboration, code review, and project management. This system allows multiple developers to work on the same codebase simultaneously without overwriting each other's changes.
Key Concepts
-
Repository (Repo): A centralized storage location for all project files, folders, and their complete revision history.
-
Git: An open-source, local version control system that tracks changes, manages different versions, and allows developers to work offline.
-
GitHub: The cloud-based hosting platform that stores Git repositories remotely and provides a web interface with additional collaboration features.
-
Branching: The practice of creating a separate, parallel line of development to work on new features or bug fixes safely, without affecting the main codebase until the changes are ready.
-
Commits: Snapshots of a project at a specific point in time, each with an associated message describing the changes made.
-
Pull Requests (PRs): A mechanism for a developer to propose changes from a feature branch to the main branch, allowing for peer review and discussion before integration.
The Typical GitHub Workflow
The standard process, often referred to as the GitHub flow, involves a series of steps to ensure code quality and seamless collaboration:
-
Set Up a Repository: A developer creates a new repository on GitHub or clones an existing one to their local machine using the
git clone command.
-
Create a Branch: A new branch is created from the main or development branch to isolate the new work. This is typically done with a command like
git checkout -b <branch-name>.
-
Make Changes and Commit: The developer works locally, making and saving changes with
git add to stage files and git commit to record the changes as a snapshot in their local repository.
-
Push Changes: The developer uploads their local commits to the remote repository on GitHub using the
git push command.
-
Open a Pull Request (PR): The developer opens a PR on GitHub to propose merging their changes into the main branch. This initiates a discussion and code review process among team members.
-
Review and Discuss: Other team members review the proposed changes, provide feedback, suggest improvements, and run automated tests using tools like GitHub Actions.
-
Merge: Once the changes are approved and all conflicts (if any) are resolved, the PR is merged into the main branch, integrating the new code into the project. The feature branch is then often deleted.
This iterative cycle allows teams to manage complexity, track history, and maintain a stable main codebase while experimenting and collaborating efficiently. The process is further enhanced by integrated tools like Issues for task tracking and GitHub Actions for automation (e.g., automated testing and deployment).
