Git Engineering Standard¶
Version: 1.0.0
Status: official
Author: Enterprise AI Standards
Description¶
Official engineering standard for version control, collaboration, branching strategy and source code management using Git.
Objective¶
Define mandatory Git practices to ensure a clean history, safe collaboration and traceable software evolution.
Philosophy¶
Git is the source of truth for software evolution. Every commit should represent a meaningful, reviewable and reversible change.
Principles¶
- Small commits.
- Atomic commits.
- Meaningful history.
- Frequent integration.
- Safe collaboration.
- Reproducible history.
- Traceability.
- Review before merge.
- Automation first.
- Never rewrite shared history.
Project Structure¶
Language Features¶
Virtual Threads¶
Structured Concurrency¶
Records¶
Sealed Classes¶
Pattern Matching¶
Collections¶
Streams¶
Optional¶
Exceptions¶
Logging¶
Performance¶
Security¶
- Never commit secrets.
- Secret scanning mandatory.
- Signed commits preferred.
Testing¶
Observability¶
Documentation¶
- README updated.
- Changelog updated.
- Architecture updated when applicable.
Best Practices¶
- Conventional Commits.
- Feature Branches.
- Small Commits.
- Frequent Pushes.
- Pull Requests.
- Protected Main.
- CI Before Merge.
- Semantic Versioning.
- Code Reviews.
- Signed Tags.
Anti Patterns¶
- Huge commits.
- Direct commits to main.
- Force push to shared branches.
- Commit generated files.
- Commit binaries.
- Commit secrets.
- Skip code review.
- Skip CI.
- Meaningless commit messages.
- Long-lived branches.
Review Checklist¶
- [ ] Conventional Commit.
- [ ] Small Commit.
- [ ] Tests Passed.
- [ ] Documentation Updated.
- [ ] README Updated.
- [ ] Pull Request Created.
- [ ] CI Passed.
- [ ] Branch Deleted After Merge.
Examples¶
References¶
- https://git-scm.com/
- https://www.conventionalcommits.org/
- https://semver.org/
- https://keepachangelog.com/