A professional and opinionated GitHub repository template to improve consistency, collaboration, and long-term maintainability for open-source or private projects.
π¦ Ready-to-clone setup for teams who care about clean Git history and a clear collaboration flow.
Related article: https://dev.to/oskhar/commitizen-making-git-commits-the-right-way-g70
This template helps you avoid:
- inconsistent commit messages
- unclear contribution rules
- repetitive repo setup across projects
Itβs designed to be reusable, team-friendly, and tool-agnostic (not tied to Node.js projects).
.czrcfor Commitizen-based interactive commits- Conventional Commits & semantic versioning support
- Clear collaboration rules in
collaboration_guide.md - GitHub-ready structure (
.github, docs-friendly layout)
git clone https://github.com/your-username/init-repo-template.git your-project-name
cd your-project-nameBefore committing anything, read:
collaboration_guide.md
It explains commit rules, branching, PR flow, and review etiquette.
git init
git remote add origin <your-new-repo-url>
npm install -g commitizen cz-gitπ‘
.czrcis already included β you can usegit czimmediately.
This template uses Commitizen to keep commit messages consistent and meaningful.
To commit:
git add .
git czFollow the interactive prompt and let the tool guide you.
- Do not commit directly to
main(except initial setup) - Always follow the commit convention
- Open pull requests with clear intent and scope
All details are documented in collaboration_guide.md.
- Open-source repositories
- Internal company projects
- Monorepo bootstrapping
- Teams learning proper Git practices
MIT β free to use, modify, and adapt.
Clone this template and make your first commit with:
git czYouβll immediately notice a cleaner, more structured workflow.