chore: update readme documentation#90
Merged
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
added support for full github urls in the
gitgo init --templatecommand and cleaned up some formatting in the readme. users can now copy and paste full urls directly from their browser instead of manually trimming them down to theowner/repoformat.Closes #
Changes
init.py: added a_parse_template_slughelper that extracts theowner/reposlug from full https urls and.gitclone links.test_init.py: added unit tests to verify the new template parsing logic handles valid urls and rejects invalid ones.README.md: added examples for the new--templateurl formats and fixed a formatting issue where changelog bullets were accidentally placed inside thegitgo initreference section.CHANGELOG.md: documented the template url parsing feature under the unreleased section.How to Test
pip install -e ".[dev]"pytest tests/test_init.py -vtest_parse_template_slugtest passes successfully.gitgo init my-test-app --template https://github.com/Huerte/GitGo.gitHuerte/GitGo, downloads the template archive, and scaffolds the local project.Checklist
CHANGELOG.mdunder the[Unreleased]sectionREADME.md(if I added or changed a command)