GitHub Workflow Guide
This guide will help you understand our practices for using GitHub effectively, ensuring smooth collaboration and efficient project management. By following these guidelines, you’ll be able to contribute to our projects seamlessly.
Early Pull Requests (PRs)
We encourage creating pull requests at the beginning of a task, not just when it is completed. This approach facilitates better collaboration and allows team members to provide feedback throughout the development process.
Naming Conventions
Ticket-Based Naming: All PRs should be named according to the ticket number from Linear or ClickUp. This ensures traceability and easy reference.
-
Example:
feat/123-add-login-featurewhere123is the ticket number.
Peer Reviews
-
Initial Peer Review: If your team includes multiple members, ensure that your PRs are peer-reviewed before escalating them.
-
Tech Lead Review: After the initial peer review, a tech lead or another experienced employee will conduct a final review to ensure code quality and adherence to standards.
Squash Merging
All PRs should be squash merged. This practice helps maintain a clean and understandable project history by focusing on single topics per PR.
Branch Management
Post-Merge Cleanup: After a PR is merged, the corresponding branch should be deleted. This helps keep the repository lean and organized.
Feature Flags
Whenever possible, use feature flags to manage new features. This allows incomplete features to be merged into the main branch without affecting production.
Example: Merge your PR with the feature flag set to false if the feature is not ready for release.