# Github Ops

> Best practices for GitHub operations and git workflow. Use when this capability is needed.

- Skill: `tomevault-io/github-ops-4` (Agent Skill, multi-file: 2 files)
- Install (CLI): `npx skillmds@latest add tomevault-io/github-ops-4`
- Raw SKILL.md: https://api.skillmd.com/api/skills/tomevault-io/github-ops-4/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Docs & Writing
- Author: tomevault-io (https://skillmd.com/u/tomevault-io)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/tomevault-io/github-ops-4

---


# GitHub Operations Skill

This skill defines the mandatory best practices for performing Git and GitHub operations within this repository.

## 1. Safety First: Push with Lease

**RULE**: NEVER use `git push --force` or `-f`.
**RULE**: ALWAYS use `git push --force-with-lease` when updating a remote branch after `amend` or `rebase`.

`--force-with-lease` ensures that you do not overwrite work pushed by others that you haven't fetched yet.

```bash
# BAD
git push --force origin feature/my-branch

# GOOD
git push --force-with-lease origin feature/my-branch
```

## 2. Commit Messages (Conventional Commits)

Follow the [Conventional Commits](https://www.conventionalcommits.org/) specification.

Format: `<type>(<scope>): <subject>`

### Types
- `feat`: New feature
- `fix`: Bug fix
- `docs`: Documentation only changes
- `style`: Changes that do not affect the meaning of the code (white-space, formatting, etc)
- `refactor`: A code change that neither fixes a bug nor adds a feature
- `perf`: A code change that improves performance
- `test`: Adding missing tests or correcting existing tests
- `chore`: Changes to the build process or auxiliary tools and libraries

### Examples
- `feat(core): add new comment parsing logic`
- `fix(ui): fix sidebar overlap issue`
- `docs(readme): update installation instructions`

## 3. Branch Naming

Use descriptive names with the following prefixes:

- `feature/`: New features
- `fix/`: Bug fixes
- `docs/`: Documentation additions/updates
- `chore/`: Maintenance tasks

Example: `feature/docs-workflow-improvement`
## 4. Pull Request Creation via GitHub CLI (`gh`)

**RULE**: AI agents SHOULD use the GitHub CLI (`gh`) for Pull Request operations to ensure reliable automation when identity-based tools fail.

### Create Pull Request
Use a markdown file for the body to ensure complex formatting is preserved.

```powershell
# 1. Create a temporary body file
$body = @"
## Overview
... description ...
"@
$body | Out-File -FilePath ".dev_output/YYYYMMDD_pr_body.md" -Encoding utf8

# 2. Create the PR
gh pr create --title "type: description" --body-file .dev_output/YYYYMMDD_pr_body.md --base main --head feature/branch-name
```

### Check PR Status
```bash
gh pr status
gh pr view --web
```

---
> Converted and distributed by [TomeVault](https://tomevault.io/claim/sun-flat-yamada) — claim your Tome and manage your conversions.
<!-- tomevault:4.0:skill_md:2026-04-13 -->