CONTRIBUTING.md

Contributing to CodingOnes GitHub Actions Workflows

Table of contents

• 📦 Prerequisites
• 🚀 Installation
• 🤝 Requirements
• 🏗️ Built with
• 🎉 Releases

Prerequisites

• Git: software for distributed version control
• GitHub: an Internet hosting service for software development

Installation

git clone git@github.com:codingones/github-actions-workflows.git

Requirements

Branches naming rules

• Must be up-to-date with main (rebased, linear history)
• Must be prefixed with follow the build/, chore/, ci/, docs/, feat/, fix/, perf/, refactor/, revert/, style/ or test/ according to their content. See Conventional Commits cheat sheet

Commits rules

Format

Must follow conventional commits specification: Commits Conventionnels

Verified

Commits must be verified: About commit signature verification

Continuous integration check

All validation checks in workflow Validate must pass without failure

Built with

Tools

CI

• GitHub Actions is the continuous integration and deployment tool provided by GitHub
• No secrets required by this repository

Releases

Release on GitHub are fully automated on merge on master with Semantic Release.