docs: update the documentations to be consistent to each other#70
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Type
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 completedpytest-covtask.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
CHANGELOG.mdunder the[Unreleased]sectionREADME.md(if I added or changed a command)