fix(init_cal): remove hardcoded 13-month limit and update README (closes #58) #60
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
) What was added: A new Running Locally section in README.md with step-by-step instructions: Clone the repo Build/install via perl Makefile.PL, make, and make install Example usage with --author, --all, and an extended --period value (e.g., --period=-36) A note under Fixes explaining the removal of the hardcoded --since="13 months" cap to support longer history visualization. Why it was done: The missing setup and usage examples caused confusion among users testing the extended-period functionality. Explicit documentation ensures users can verify and utilize the feature fix (k4rthik#58) immediately. References: Closes k4rthik#58
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
What
Removed the hardcoded --since="13 months" filter in git log to allow any negative value for --period (e.g., --period=-36) in init_cal_stuff.
Added a Running Locally section to README.md with step-by-step installation and extended-period usage examples.
Documented the fix under Changelog/Fixes in the README to clearly explain the resolved issue.
Why
This resolves issue #58, enabling use cases where repositories haven’t been updated in over a year. It improves the tool’s flexibility and ensures that long-term history can be visualized—while also giving users clear instructions to test and verify the enhanced behavior.
How to Test
Clone and install locally:
Verify README updates:
The README.md includes the new “Running Locally” section.
The changelog notes the removal of the 13-month filter.