Repository navigation
docs: README and news for the 0.1.0 release - #45
Merged
Merged
Conversation
The README said nothing was released and no real backend existed; it now describes what 0.1.0 has (CalDAV, files, configuration, time tracking) and installs from PyPI, and its example writes to a temporary directory instead of the in-memory backend. The release table goes from the README, and the release plan from the roadmap: releases are made when needed, not to a preset plan. The news fragments go too: a first release has no earlier version to compare with, and its change log entry, written by hand at release time, will say just that. news/.gitkeep keeps the directory for the next release's fragments. Prompt: We should work on a 0.1.0-release There is a handover note here with some loose ends from yesterday Followup-Prompt: Go on with the 0.1.0 prep Prompts (comments made inline in the document while reviewing it): > (replacing the whole rendered 0.1.0 change log draft) 0.1.0 is the first release. The CHANGELOG should be the place to look for "what have changed since the last version?". The CHANGELOG for v0.1.0 is intentionally left blank since there does not exist any "last version" to compare with (alternatively, we could let the CHANGELOG list all the features of the library, but that's better described in other documentation). > (on the finding that the roadmap's release plan contradicts the README) The ROADMAP should not have a release plan. Releases happens (sic) when I feel for it or when it's needed, not according to some preset plan. Assisted-By: Claude Opus 5.5 <noreply@anthropic.com> Reviewed-by: Tobias Brox <tobias@redpill-linpro.com>
The README did not say what the "other standards" were other than, and "CalDAV library" blurred the protocol and the library. The library is now `caldav` throughout the README. Prompt: Change "I've considered supporting other standards in the CalDAV library" to "I've considered supporting other standards than CalDAV in the caldav library" Followup-Prompt: I've decided to consistently either write "caldav" or "The Python CalDAV client library" about the library, while the standard is named CalDAV Assisted-By: Claude Opus 5.5 <noreply@anthropic.com> Reviewed-by: Tobias Brox <tobias@redpill-linpro.com>
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.
Commit message:
Also piggy-backing:
docs: the caldav library, written one wayCI's changelog check needs the
skip-changeloglabel: this PR removes the news fragments instead of adding one.