From 178fc7f248b996ae1f96bbea6c987ed0dd368cf7 Mon Sep 17 00:00:00 2001 From: Huerte Date: Fri, 29 May 2026 18:51:29 +0800 Subject: [PATCH 1/2] docs: update the pr template and CONTRIBUTING.md --- .github/PULL_REQUEST_TEMPLATE.md | 19 +++++-------------- CONTRIBUTING.md | 27 +++++++++++++++------------ 2 files changed, 20 insertions(+), 26 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index d365ee2..3bf628f 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,5 +1,4 @@ - ## Type @@ -15,32 +14,24 @@ - +Fixes # ## Changes - -## Breaking Changes - - - -**Breaking changes:** None - ## How to Test 1. `pip install -e ".[dev]"` @@ -55,4 +46,4 @@ - [ ] I updated `CHANGELOG.md` under the [`[Unreleased]`](https://github.com/Huerte/GitGo/blob/main/CHANGELOG.md) section - [ ] I updated `README.md` (if I added or changed a command) - [ ] I added or updated tests for my change (if applicable) -- [ ] My change does not break any existing commands \ No newline at end of file +- [ ] My change does not break any existing commands (if it does, describe the impact in the Overview) \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6c1df0c..3916d07 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -175,18 +175,21 @@ git commit -m "update" ## Good First Issues -Not sure where to start? Pick something from the list below. - -| Task | Difficulty | Description | -|------|------------|-------------| -| `gitgo log` | ⭐ | Wrap `git log --oneline --color` and print it with GitGo's color helpers from `utils/colors.py`. | -| `gitgo amend` | ⭐ | Wrap `git commit --amend -m ""`. Add a confirmation prompt before rewriting. | -| `pytest-cov` setup | ⭐ | Add `pytest-cov` to `dev` dependencies in `pyproject.toml` and verify coverage runs with `pytest --cov`. | -| GitLab SSH support | ⭐⭐ | The regex in `auth/ssh_utils.py` only matches `github.com`. Extend it to handle `gitlab.com` and `bitbucket.org`. | -| `gitgo status` | ⭐⭐ | Parse `git status --porcelain` and display staged, unstaged, and untracked files in labeled groups. Edge cases: renamed files, merge conflicts. | -| Shell completions | ⭐⭐⭐ | Add tab-completion for Bash/Zsh/Fish via `argcomplete` or hand-written completion scripts. PowerShell optional. | - -Check the [open issues](https://github.com/Huerte/GitGo/issues) for the current list labeled `good first issue`. +Not sure where to start? The table below lists tasks sized for a first contribution. Each one is self-contained and has a clear scope. + +Before picking one, clone the repo and read through the project structure in [`CONTRIBUTING.md`](CONTRIBUTING.md) so you know where things live. + +| Task | Difficulty | Where to start | What to do | +|------|------------|----------------|------------| +| `gitgo log` | ⭐ | `utils/colors.py` | Wrap `git log --oneline --color` and format the output using the existing color helpers. | +| `gitgo amend` | ⭐ | New command file | Wrap `git commit --amend -m ""`. Add a confirmation prompt before it runs — amend rewrites history, so the user should opt in. | +| `gitgo diff` | ⭐ | New command file | Wrap `git diff` and `git diff --staged`. Add a `-s` / `--staged` flag to toggle between unstaged and staged output. | +| GitLab & Bitbucket SSH | ⭐⭐ | `auth/ssh_utils.py` | The host regex only matches `github.com`. Extend it to cover `gitlab.com` and `bitbucket.org`. | +| `gitgo status` | ⭐⭐ | New command file | Parse `git status --porcelain` and display staged, unstaged, and untracked files in labeled groups. Handle renamed files and merge conflict markers as edge cases. | +| `gitgo branch` | ⭐⭐ | New command file | Parse `git branch -a` and list all branches with the current one highlighted. Separate local and remote branches into labeled groups. | +| Shell completions | ⭐⭐⭐ | New file | Add tab-completion for Bash, Zsh, and Fish using `argcomplete` or hand-written scripts. PowerShell is optional. | + +If nothing here fits, check the [open issues](https://github.com/Huerte/GitGo/issues) for anything tagged `good first issue`. If you have an idea that isn't listed, open an issue first before writing code. --- From 6fdae86208282684f51568c76df589760a28daa1 Mon Sep 17 00:00:00 2001 From: Huerte Date: Fri, 29 May 2026 18:58:17 +0800 Subject: [PATCH 2/2] docs: add a comment in pr template --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 3bf628f..91c3412 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -14,7 +14,7 @@ -Fixes # +Closes # ## Changes