Welcome to GO-Trainee! We're excited to have you on board for this educational project. Here, you'll find some valuable recommendations to ensure smooth collaboration and efficient development practices. These guidelines will help you navigate through the project, maintain a clean commit history, and make the most out of your learning experience. Let's dive in!
The trainee project encompasses both functional and non-functional requirements, providing a comprehensive learning experience. You can find the project repository here.
In order to foster collaboration, maintain a clean and understandable commit history, and streamline the development process, they prove valuable for project management and code maintenance:
-
When working in feature branches, use the "Squash and Merge" feature when merging your changes into the target branch (usually develop or main). This helps maintain a clean commit history, reduces clutter, and simplifies understanding of changes by other team members.
-
If you need to integrate the latest changes from the main branch into your feature branch, it is preferable to use rebase instead of regular merging. This helps maintain a clean commit history, reduces the likelihood of conflicts, and contributes to a clearer history of changes in your repository.
-
GitHub Container Registry (GHCR) provides a convenient place to store and manage Docker images directly within your repository. When developing software that depends on containerization, using GHCR can significantly simplify the process of deployment and managing containers.
-
Aim for frequent, logical commits, each making small but meaningful changes. Each commit should have a descriptive message that clearly explains what was changed and why. The specification is located here.