@Malix-Labs General Repository Template

After creating a repository from the @Malix-Labs repository template, this file has to be cleared. It is accessible online at https://github.com/Malix-Labs/Template#readme

Usage

1. [ ] Create a repository from this template
2. [ ] Search "github.com/USERNAME/REPOSITORY" and replace all "USERNAME" by the User/Organization name and "REPOSITORY" by the Repository name
3. [ ] Copy all this repository GitHub Settings
4. [ ] Copy all this repository GitHub Labels

Features

Branching

Inspired by Trunk-Based Development / GitHub Flow

• Default (main/master): the single source of truth, fully protected
• Issues (issue/*): short-lived branches for individual issues
• Archives (`archive//`)*: branches for archival purposes
• Releases (release/*): branches for preparing a release
  • Releases' Issues (release/*/issue/*): issue work scoped under a specific release
  • Releases' Archives (`release/*/archive//`)*: archival work scoped under a specific release

Tags

Optimized for Continuous Deployment (CD)

Using Semantic Versioning (SemVer) (current: v2)

Each push to the default branch should be tagged with a SemVer Tag

Non-SemVer Tags are not encouraged (at least not for long-lived purposes) but allowed

GitHub Releases

Optimized for Continuous Deployment (CD)

Each SemVer Tag pushed to the default branch is meant to be released

Deployments

Optimized for Continuous Deployment (CD)

Each GitHub Release is meant to be deployed

Deployments are meant to be executed from a pipeline (preferably GitHub Workflow) triggered by the GitHub Deployments

Rulesets

Rulesets Files Directory (download)

| Type | Name | Status | Bypass | Targets | Rules | File | | ------ | ---------------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- | | Branch | Archives | Active |

• Repository admin (Role) - Always allow
• Maintainer (Role) - Always allow
• Dependabot (App • github) - Always allow

|

• + archive/**/*
• + release/*/archive/**/*

|

• Restrict updates
• Restrict deletions
• Block force pushes

| File | | Branch | Issues | Active |

• Repository admin (Role) - Always allow
• Maintainer (Role) - Always allow
• Dependabot (App • github) - Always allow

|

• + issue/*
• + release/*/issue/*

|

• Restrict creations
• Restrict deletions
• Block force pushes

| File | | Branch | Production - Constructive | Active |

• Repository admin (Role) - Always allow
• Maintainer (Role) - Allow for pull requests only
• Dependabot (App • github) - Always allow

|

• + Default
• + release/*

|

• Restrict creations
• Require deployments to succeed
• Require signed commits
• Require a pull request before merging
  • Required approvals: 0
  • Dismiss stale pull request approvals when new commits are pushed
  • Require review from Code Owners
  • Require approval of the most recent reviewable push
  • Require conversation resolution before merging
  • Request pull request review from Copilot
  • Allowed merge methods
    • Merge
    • Squash
    • Rebase
• Require code scanning results
  • CodeQL - High or higher - Errors

| File | | Branch | Production - Destructive | Active |

• Repository admin (Role) - Always allow

|

• + Default
• + release/*

|

• Restrict deletions
• Block force pushes

| File | | Tag | Semantic Versioning - Constructive | Active |

• Repository admin (Role)
• Maintainer (Role)
• Dependabot (App • github)

|

• + v[0-9]*

|

• Restrict creations
• Restrict updates
• Require deployments to succeed
• Require signatures

| File | | Tag | Semantic Versioning - Destructive | Active |

• Repository admin (Role)

|

• + v[0-9]*

|

• Restrict deletions
• Block force pushes

| File |

GitHub Labels

| Name | Description | Color | | ----------- | ----------- | ------- | | Feature | | #00FF00 | | Enhancement | | #00FFFF | | Fix | | #FF8000 | | Update | | #FFFF00 | | Deprecation | | #FF0000 |

GitHub Milestones

• "v1.0.0"

GitHub Issue and Pull Request Template

GitHub Project Template

The best starting GitHub project template for any project scale

GitHub Discussions Sections & Categories

Sections

| Name | Emoji | Categories | | ----------- | ----- | ---------- | | Development | 🧑‍💻 | None | | Usage | ✔️ | None |

Categories

| Name | Emoji | Description | Format | Section | | ------------- | ----- | ----------- | --------------------- | ------- | | Announcements | 📣 | | Announcement | None | | General | 💬 | | Open-ended discussion | None | | Questions | ❔ | | Question / Answer | None | | Poll | 🗳️ | | Poll | None |

GitHub Discussion Category Form

GitHub Actions

Optimized for Trunk-Based Development / GitHub Flow

• On issue create:
  • [ ] Create a branch named as the issue ID and link it to the created issue
    • On first commit push to this branch:
      • [ ] Create a draft pull request to the parent issue if any, else master
• On push to master:
  • [ ] Create a draft release with a tag annoted with the latest semver tag incremented by one patch

GitHub Files

Fully featued with GitHub files

GitHub Settings

GitHub Settings cannot be embeded in a GitHub repository template copied data, therefore, you have to copy them manually

General

Pull Requests

• Allow merge commits Default commit message: Pull request title
• Allow squash merging Default commit message: Default message
• Allow rebase merging