agis/git-style-guide
Git Style Guide
Dieses Projekt ist ein Styleguide für die Versionskontrolle, der standardisierte Regeln für Commit-Nachrichten, Branch-Benennungen und History-Management bereitstellt. Es dient als umfassendes Framework zur Wahrung einer konsistenten und lesbaren Projekthistorie durch eine Reihe definierter Richtlinien und Workflow-Dokumentationen.
Der Leitfaden betont ein lineares Branching-Modell und nutzt Rebase- und Squash-Techniken, um eine gerade Zeitlinie von Commits beizubehalten. Er spezifiziert ein strukturiertes Commit-Layout unter Verwendung imperativer Sprache und eine Kebab-Case-Benennungskonvention für Branches, um organisatorische Klarheit über Teams hinweg sicherzustellen.
Die Dokumentation deckt zudem die Repository-Wartung durch regelmäßige Garbage-Collection und Pruning ab sowie eine Tagging-Konvention, die zwischen annotierten Tags für öffentliche Releases und leichtgewichtigen Tags für persönliche Marker unterscheidet. Die Commit-Strukturierung konzentriert sich auf die Gruppierung zusammengehöriger Änderungen in logische Einheiten, um das Auditieren und Rückgängigmachen zu vereinfachen.
Features
- Git Version Control Standards - Provides a comprehensive set of standardized rules for commit messages, branch naming, and history management.
- Tagging Conventions - Defines a structured system to distinguish between annotated tags for public releases and lightweight tags for personal markers.
- Commit Standards - Establishes conventions for formatting commit messages using imperative language to ensure history readability.
- Structured Commit Histories - Defines a structured layout for commit messages to ensure a consistent and readable project history.
- Branch Naming Conventions - Provides standardized kebab-case naming patterns for branches to ensure organizational clarity across teams.
- Git Branching & Merging - Standardizes the organization of feature branches and cleanup strategies to maintain a clear development workflow.
- History Linearization - Employs rebasing and squashing techniques to maintain a linear sequence of commits in the project history.
- Branch Merging Strategies - Defines workflows for integrating changes from different branches while maintaining a clean linear progression.
- Commit History Management - Utilizes squashing and rebasing techniques to organize commit history and preserve a clean repository timeline.
- Commit Message Standards - Provides best practices for writing informative, imperative commit messages with a structured summary and body.
- Git History Management - Provides practices for organizing and cleaning the version control timeline through rebasing and squashing.
- Git Workflow Instruction - Offers educational guidelines on managing version control history through branching, merging, and rebasing.
- Release Tagging Patterns - Defines naming and type conventions for tags to distinguish between public releases and personal markers.
- Manual Release Tagging - Defines how to label specific commits with tags to mark official releases and internal milestones.
- Repository Health Maintenance - Provides guidelines for using garbage collection and pruning to optimize the internal health of Git object storage.
- Development Environment Standards - Recommendations for Git usage and commit styles.
- Editor and Tooling - Best practices and style guide for Git usage.
