github-workflow

Explains Git/GitHub workflow for MAPL including branching, commits, and pull requests.

43|25|Updated Jul 3, 2019
One-click install
npx skills add https://github.com/GEOS-ESM/MAPL --skill github-workflow-geos-esm
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: github-workflow
Source: https://github.com/GEOS-ESM/MAPL/tree/main/.opencode/skills/github-workflow
Command: npx skills add https://github.com/GEOS-ESM/MAPL --skill github-workflow-geos-esm

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides clear, actionable guidelines for using Git and GitHub within the MAPL project, ensuring code quality, consistency, and efficient collaboration.

Core Features & Use Cases

  • Commit & Push Rules: Enforces critical rules to prevent accidental breaking changes.
  • Branching Strategy: Defines clear base branches (develop, release/MAPL-v3) and feature branch naming conventions.
  • Pull Request Process: Outlines prerequisites, PR templates, and review expectations.
  • Use Case: A new contributor can use this Skill to understand exactly how to create a feature branch, make commits, and submit a pull request that adheres to MAPL's standards.

Quick Start

Follow the steps outlined in this skill to create a new feature branch for your work.

Frequently Asked Questions about github-workflow

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I set up a feature branch for the MAPL GitHub workflow?

To set up a feature branch in the MAPL GitHub workflow, create your branch from the correct base branch, either `develop` or `release/MAPL-v3`, following the project's specific naming conventions to ensure proper version control and collaboration.

What commit message format is required for MAPL version control?

The MAPL version control workflow requires a specific commit message formatting standard to maintain code quality and consistency. Adhering to these commit conventions ensures clear tracking of changes and prevents accidental breaking changes during collaboration.

How do I submit a pull request that meets MAPL code review expectations?

To submit a pull request for MAPL, you must complete the required prerequisites and fill out the designated PR template. Meeting these submission standards ensures your code changes align with project expectations and pass the code review process.

What are the branching strategies for managing MAPL develop and release branches?

The MAPL branching strategy defines `develop` and `release/MAPL-v3` as critical base branches. It enforces strict branch management rules and feature branch naming conventions to prevent accidental breaking changes and maintain code quality across the version control workflow.

When should I target develop versus release/MAPL-v3 for my feature branch?

You should target `develop` for ongoing general feature work and `release/MAPL-v3` for changes specific to that version. Selecting the correct base branch is a critical rule in the MAPL Git workflow to prevent breaking changes and maintain project stability.