Add README usage guide and AGENTS.md#26
Merged
Merged
Conversation
Replace the skeleton README template with real documentation: project overview, requirements, the schedule → agenda → slotter pipeline, runnable usage examples drawn from the test suite, the WeeklySchedule JSON schema, timezone notes, and caveats. Add AGENTS.md describing the architecture, conventions, gotchas, commands, and working agreements for contributors and AI coding agents. Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
marianogoldman
added a commit
that referenced
this pull request
Jun 13, 2026
Rebuild CHANGELOG.md in Keep a Changelog format from every tagged release (v0.0.1 through v4.1.2) using the GitHub release notes and the merged PRs between tags. The Unreleased section also captures the changes already on master without a release yet (#25, #26) alongside the security hardening. Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
marianogoldman
added a commit
that referenced
this pull request
Jun 13, 2026
* Harden scheduling against unbounded ranges and invalid input Security review follow-up. No injection or vulnerable dependencies were found; the realistic risks were resource exhaustion and weak input validation. This addresses them: - Cap requested date ranges (DoS guard). WeeklyScheduleAgenda, AgendaSlotter and DaySlotter now take an optional maxDays argument (default 366, 0 disables) and throw DateRangeTooLargeException when the [from, to] window is larger, via a shared DateRangeGuard. - Reject non-positive duration/step (and negative timeAfter/timeBefore) in the slotters with InvalidArgumentException, preventing degenerate zero-interval loops. - Validate WeeklySchedule times strictly as a time of day (HH:MM or HH:MM:SS, 00:00-23:59), rejecting relative expressions such as "now". - Throw a clear Exception on malformed/non-object JSON in WeeklySchedule::fromJson() instead of a TypeError. Docs (README caveats + schema note) and CHANGELOG updated. Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]> * Reconstruct historical changelog from past releases Rebuild CHANGELOG.md in Keep a Changelog format from every tagged release (v0.0.1 through v4.1.2) using the GitHub release notes and the merged PRs between tags. The Unreleased section also captures the changes already on master without a release yet (#25, #26) alongside the security hardening. Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]> --------- Co-authored-by: Claude Opus 4.8 (1M context) <[email protected]>
marianogoldman
added
the
documentation
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
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.
Summary
Documentation-only change. No code or behavior is modified.
WeeklySchedule → Agenda → TimeSlotter → slotspipeline, with a concepts table.WeeklyScheduleAgenda,SingleDateRangeAgenda,AgendaSlotterwith before/after gaps,DaySlotter), all drawn from the existing test suite.WeeklyScheduleJSON schema, timezone behavior, and caveats (hours_in_advanceis metadata only;disable_allis enforced).Testing
Not applicable — docs only. The full suite (37 tests) was run locally and passes on PHP 8.4 to confirm the documented examples reflect real behavior.
🤖 Generated with Claude Code