Add CONTRIBUTING.md and surface Slides in README#204
Merged
Conversation
Move the contributor workflow out of the stub Contributing section into a top-level CONTRIBUTING.md so external contributors and agents can find it without first reading CLAUDE.md. Covers the design-doc + task-plan workflow, verification lanes, commit format, PR and review process, AI agent-assisted contributions, and package-specific gotchas. Also surface Slides in the README. The package was missing from the Features list, the Tech Stack table, and the Project Structure list, so a casual reader could not tell Slides existed. Update the tagline to mention sheets, docs, and slides together.
📝 WalkthroughWalkthroughThis pull request introduces a comprehensive contribution guide for Wafflebase ( ChangesAdd Contribution Guidelines
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Contributor
Verification: verify:selfResult: ✅ PASS in 163.2s
Verification: verify:integrationResult: ✅ PASS |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
3 tasks
hackerwins
added a commit
that referenced
this pull request
May 10, 2026
Each package already has its own README, but there was no top-level entry point inside `packages/` that summarised what lives where. Splits the listing into engines (sheets, docs, slides) and apps and services (frontend, backend, cli, documentation) so a new contributor can orient before drilling into a single package. Four active tasks have shipped on main (PR #189 undo-destroys-initial-block, #202+#205 slides-shapes-p1, #206 slides-thumb-responsive, #204 contributing-md) but their todo files were still sitting in `docs/tasks/active/` because some checkboxes were never ticked. Mark the remaining items done and run `pnpm tasks:archive` to move the five files into `archive/2026/05/`. While there, eight April task docs were still loose at the archive root (predating the by-month layout). Move them into `archive/2026/04/` so the directory is uniformly organised and the index counts stay accurate. Co-authored-by: Claude Opus 4.7 (1M context) <[email protected]>
hackerwins
added a commit
that referenced
this pull request
May 11, 2026
Adds @wafflebase/slides as a third surface alongside Sheets and Docs, plus 53-shape library (Phase 1+2), adjustment handles for 9 pilot shapes (P3-A.1), live snap guides, align/distribute toolbar, themed authoring, and layout-change UI. Also ships Sheets cell comments (Phase B), docs peer-avatar caret jump, yorkie-js-sdk 0.7.8 upgrade, and CLI/REST API improvements (docs export imageFetcher, expired session refresh, REST docs split). Minor bump because slides is a new top-level package. Highlights: #184 #185 #186 #187 #188 #189 #190 #191 #192 #197 #198 #201 #202 #203 #204 #205 #206 #207 #209 #210
3 tasks
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
CONTRIBUTING.mdcovering the agentic workflow already used in the repo: design docs indocs/design/, task plans indocs/tasks/active/, the three verify lanes, commit format, PR + review process, AI agent-assisted contributions, and package-specific gotchas (ANTLR, Store/DocStore, integration tests, chunk budgets).## Contributingtrimmed to a one-line pointer;Documentationindex now lists CONTRIBUTING.md.### Slidesblock under Features, aSlides enginerow in Tech Stack, andpackages/slides/in Project Structure (also fixedpackages/cli/to link its README and updated the workspace-deps line).CONTRIBUTING.mdbut rewritten around our own conventions: no separate spec-PR flow, no per-PR CHANGELOG entry (release notes auto-generated), and a CLA marked as planned but not required today.Why
The README's Contributing section was a stub and the agentic workflow was only documented in
CLAUDE.md/AGENTS.md— fine for AI agents, but a poor entry point for human contributors. CONTRIBUTING.md is the conventional landing page that GitHub also surfaces in the issue/PR sidebar.Slides has shipped enough features to warrant top-level visibility in the README; previously a reader could miss that the package existed.
Linked Issues
None.
Verification
CI automatically posts a verification summary comment on this PR with
per-lane results for both
verify:selfandverify:integration.Skip reason (if applicable):
Local:
pnpm verify:fastgreen (47 test files / 764 tests). Docs-only change, no code paths touched.Risk Assessment
Notes for Reviewers
docs/tasks/active/20260510-contributing-md-todo.md.## Statusblock in README still says "spreadsheet and document editing" — left as-is for now since Slides is still v1; happy to widen the wording in a follow-up if preferred.Summary by CodeRabbit