Source Control

Source Control with Git and GitHub

In our game development project, we follow best practices for source control using Git and GitHub. Here's an overview of our approach:

Feature Branch Workflow

1. Feature Branches:

   • We create a separate branch for each feature or user story.
   • Naming convention: <JiraTag>-<FeatureName> (e.g., BCC-20-Documentation).
   • Feature branches keep the main branch clean and allow parallel development.

2. Commit History:

   • We have over 100 commits in our repository.
   • Each commit is meaningful and represents a specific change or feature.
   • Commit messages follow a clear and concise format (e.g., "Added tests for abstract enemy." "Added datatypes and return types.").

3. Code Reviews:

   • Before merging a feature branch, we conducted code reviews(Created pause menu! #24).
   • Code reviews ensure quality, consistency, and adherence to coding standards.
   • Reviewers provide feedback, suggest improvements, and catch issues early.

GitHub Integration

1. Pull Requests (PRs):

   • We use pull requests to merge feature branches into the main branch.
   • PRs include a summary of changes.

2. Branch Protection Rules:

   • We set up branch protection rules on the main branch.
   • These rules prevent direct pushes to the main branch and require PR approval.

Benefits

• Isolation: Feature branches isolate work, preventing conflicts.
• Traceability: Each branch corresponds to a specific feature or issue.
• Collaboration: Code reviews foster collaboration and knowledge sharing.
• Stability: The main branch remains stable and deployable.

By following these practices, we maintain a clean and organized repository, ensuring efficient collaboration and high-quality code. 🚀🔧