Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
87 lines (62 loc) · 3.21 KB

CONTRIBUTING.md

File metadata and controls

87 lines (62 loc) · 3.21 KB
Raw

Contributing to .github

Thank you for your interest in contributing to .github! This document provides guidelines and information for contributors.

How to Contribute

Reporting Bugs

  1. Search existing issues at github.com/zircote/.github/issues to avoid duplicates.
  2. If no existing issue matches, open a new bug report.
  3. Include as much detail as possible: steps to reproduce, expected vs actual behavior, environment details, and logs or screenshots.

Suggesting Features

  1. Check discussions and issues to see if the feature has already been proposed.
  2. Open a feature request with a clear description of the problem and your proposed solution.

Submitting Pull Requests

  1. Fork the repository and create a branch from main.
  2. Make your changes in a focused, well-scoped branch.
  3. Write or update tests to cover your changes.
  4. Update documentation if your changes affect public APIs or user-facing behavior.
  5. Open a pull request against main using the PR template.

Development Setup

This repository holds GitHub configuration (workflows, composite actions, skills, agents) — there is no application build or test suite. The development loop is:

  1. Clone your fork: 
    git clone https://github.com/<your-username>/.github.git
cd .github
  2. Validate workflow changes with actionlint: 
    actionlint .github/workflows/<changed-file>.yml
  3. For gh-aw agentic workflows (.github/workflows/*.md), compile and patch with: 
    bash scripts/compile-gh-aw.sh <workflow-name>
    The generated .lock.yml files are build artifacts — never edit them directly.
  4. Every uses: reference must be pinned to a full 40-char commit SHA; the pin-check required CI check enforces this on every pull request.

Code Style

  • Follow the existing code style and conventions in the project.
  • Run linters and formatters before committing.
  • Keep changes focused: one logical change per commit.

Commit Messages

Use clear, descriptive commit messages:

<type>: <short summary>

<optional body with more detail>

Types: feat, fix, docs, style, refactor, test, chore, ci

Examples:

  • feat: add user profile page
  • fix: correct date parsing for ISO 8601 format
  • docs: update API reference for v2 endpoints

Pull Request Process

  1. Fill out the PR template completely.
  2. Link related issues using Fixes #123 or Closes #456.
  3. Ensure all CI checks pass.
  4. Request a review from a maintainer or code owner.
  5. Address review feedback promptly.
  6. Once approved, a maintainer will merge your PR.

Code of Conduct

This project follows the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code. Report unacceptable behavior to the project maintainers.

Questions?