Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
name: Bug report
about: Report a bug or regression in GitCoach
title: "[Bug] "
labels: bug
assignees: ""
---

## Summary

Describe what went wrong.

## Reproduction

1. Command(s) run:
2. Current branch:
3. Expected behavior:
4. Actual behavior:

## Environment

- OS:
- Python version:
- Git version:
- GitCoach version (`gitcoach --help` output is fine):

## Notes

Add logs/output/screenshots if useful.
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Questions and usage help
url: https://github.com/your-org/gitcoach/discussions
about: Ask usage questions and get support.
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: Feature request
about: Suggest an improvement to GitCoach
title: "[Feature] "
labels: enhancement
assignees: ""
---

## Problem

What user problem are you trying to solve?

## Proposed solution

Describe the command/menu/behavior you want.

## Beginner UX impact

How does this reduce confusion or prevent mistakes?

## Alternatives considered

What else did you try?
56 changes: 56 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
name: CI

on:
push:
branches: ["main"]
pull_request:

jobs:
test:
name: tests (${{ matrix.os }}, py${{ matrix.python-version }})
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
os: [ubuntu-latest, macos-latest]
python-version: ["3.10", "3.11", "3.12"]
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}

- name: Install package + dev deps
run: |
python -m pip install --upgrade pip
python -m pip install -e ".[dev]"

- name: Run tests
run: pytest

build:
name: build package
runs-on: ubuntu-latest
needs: [test]
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: "3.12"

- name: Build sdist/wheel
run: |
python -m pip install --upgrade pip build
python -m build

- name: Upload dist artifacts
uses: actions/upload-artifact@v4
with:
name: dist
path: dist/*
36 changes: 36 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: Release

on:
push:
tags:
- "v*"

jobs:
publish:
runs-on: ubuntu-latest
permissions:
id-token: write
contents: write
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: "3.12"

- name: Build
run: |
python -m pip install --upgrade pip build
python -m build

- name: Publish to PyPI
uses: pypa/gh-action-pypi-publish@release/v1

- name: Create GitHub Release
uses: softprops/action-gh-release@v2
with:
generate_release_notes: true
files: |
dist/*
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
__pycache__/
*.pyc
.gitcoach-mailmap
.pytest_cache/
.coverage
dist/
build/
*.egg-info/
19 changes: 19 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Changelog

All notable changes to this project are documented in this file.

The format follows Keep a Changelog and this project aims to follow Semantic Versioning.

## [0.1.0] - 2026-02-24

### Added

- Interactive menu with beginner-oriented workflows.
- Doctor flows for identity diagnostics and email history rewrite.
- Multi-repo doctor scan mode (`doctor --all-repos`).
- Safety guard hooks (`guard`, and guard install during `init`).
- Undo/rollback submenu and command.
- Commit message helper (`message`, `save --guided`, `--strict-message`).
- Packaging metadata (`pyproject.toml`) and `gitcoach` console entrypoint.
- Test suite for core safety behavior.
- CI workflow and release workflow scaffolding.
35 changes: 35 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Contributing

Thanks for helping improve GitCoach.

## Local Setup

```bash
python3 -m pip install -e ".[dev]"
```

Run tests:

```bash
pytest
```

Run CLI locally:

```bash
gitcoach --help
gitcoach interactive
```

## Contribution Rules

- Keep UX beginner-first and low-cognitive-load.
- Prefer guardrails over raw power for destructive operations.
- For new risky operations, include rollback guidance and backups.
- Add or update tests for safety-critical behavior changes.

## PR Checklist

- [ ] Tests pass locally (`pytest`)
- [ ] README reflects user-facing behavior changes
- [ ] Safety-critical changes include test coverage
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2026 GitCoach Contributors

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Loading