Skip to content

docs: update the documentations to be consistent to each other#70

Merged
Huerte merged 1 commit into
mainfrom
docs/update-templates
May 29, 2026
Merged

docs: update the documentations to be consistent to each other#70
Huerte merged 1 commit into
mainfrom
docs/update-templates

Conversation

@Huerte
Copy link
Copy Markdown
Owner

@Huerte Huerte commented May 29, 2026

Type

  • Bug fix
  • New feature
  • Documentation
  • Refactor / internal

Overview

This PR updates the repository templates and documentation to follow open-source community guidelines. It simplifies instructions, fixes a self-referential link, and replaces em-dashes in both markdown files and CLI output.

Changes

  • CONTRIBUTING.md: updated the list of PR template sections, fixed a self-referential link, and removed the completed pytest-cov task.
  • README.md: replaced an em-dash with a new sentence to comply with project writing guidelines.
  • CHANGELOG.md: replaced em-dashes with colons for formatting consistency.
  • src/pygitgo/main.py: replaced em-dashes in CLI terminal success messages with colons.

Checklist

  • I tested my changes locally and they work
  • I updated CHANGELOG.md under the [Unreleased] 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 (if it does, describe the impact in the Overview)

@Huerte Huerte merged commit 4402b58 into main May 29, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant