basic-repo-template

Introduction

🚀 This repository serves as a basic template for creating new repositories. It's designed to be a foundation for structure and organization. 🎯

🌍 Key Features

• 📦 A clean, reusable structure for quick repo setup.
• 🗣️ Language-specific templates can inherit and extend from this base.
• 🔄 Easily customizable for various projects and use cases.

✨ Perfect for

• Developers looking for a clean start 🛠️
• Language-specific templates 👨‍💻
• Seamless repository setup for quick deployments ⚡

Feel free to fork, extend, and contribute! 🤝

Usage

To use this repository template, simply fork the repo.

gh repo fork --fork-name <FORK_NAME> --org <ORG_NAME>

Update the repository settings:

gh repo edit --add-topic devops,reliability-engineering,axes \
--add-topic infrastructure-as-code,viking,mosher-labs \
--delete-branch-on-merge --enable-discussions=false \
--enable-issues=false --enable-merge-commit=false \
--enable-projects=false --enable-rebase-merge=false \
--enable-wiki=false

Create a ruleset for the default branch.

• Ruleset Name: Default branch
• Enforcement status: Active
• Target Branches: Default
• ✅ Restrict deletions
• ✅ Require linear history
• ✅ Require signed commits
• ✅ Require a pull request before merging
• ✅ Dismiss stale pull request approvals when new commits are pushed
• ✅ Require conversation resolution before merging
• ✅ Request pull request review from Copilot
• Allowed merge methods: "Squash"
• ✅ Require status checks to pass
• ✅ Require branches to be up to date before merging
• ✅ Do not require status checks on creation
• Status checks that are required: pre-commit/pre-commit
• ✅ Block force pushes
• ✅ Require code scanning results

Enable Dependabot.

• In Github UI, navigate to the repositories Settings > Code security
• Enable Dependabot security updates
• Enable Grouped security updates
• Enable Dependabot version updates
• Enable Dependabot on Actions runners
• CodeQL analysis > Set up > Default
• Enable Secret scanning
• Enable Push protection

Update the templated information:

README.md

• Replace basic-repo-template with your <FORK_NAME>
• Update the "Introduction" section
• Update the "Usage" section
• Update the "Contributing" section

🔰 Contributing

Upon first clone, install the pre-commit hooks.

pre-commit install

To run pre-commit hooks locally, without a git commit.

pre-commit run -a --all-files

To update pre-commit hooks, this ideally should be ran before a pull request is merged.

pre-commit autoupdate