Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mosher-labs/basic-repo-template

🚀 This repository serves as a basic template for creating new repositories. It's designed to be a foundation for structure and organization. 🎯
https://github.com/mosher-labs/basic-repo-template

axes devops infrastructure-as-code mosher-labs reliability-engineering viking

Last synced: about 20 hours ago
JSON representation

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

Awesome Lists containing this project

README

        

# basic-repo-template

![GitHub branch status](https://img.shields.io/github/checks-status/mosher-labs/basic-repo-template/main)
![GitHub Issues](https://img.shields.io/github/issues/mosher-labs/basic-repo-template)
![GitHub last commit](https://img.shields.io/github/last-commit/mosher-labs/basic-repo-template)
![GitHub repo size](https://img.shields.io/github/repo-size/mosher-labs/basic-repo-template)
![Libraries.io dependency status for GitHub repo](https://img.shields.io/librariesio/github/mosher-labs/basic-repo-template)
![GitHub License](https://img.shields.io/github/license/mosher-labs/basic-repo-template)
![GitHub Sponsors](https://img.shields.io/github/sponsors/mosher-labs)

## 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.

```bash
gh repo fork --fork-name --org
```

Update the repository settings:

```bash
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 ``
- [ ] Update the "Introduction" section
- [ ] Update the "Usage" section
- [ ] Update the "Contributing" section

## 🔰 Contributing

Upon first clone, install the pre-commit hooks.

```bash
pre-commit install
```

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

```bash
pre-commit run -a --all-files
```

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

```bash
pre-commit autoupdate
```