Propose a bunch of changes to Lawrence's draft claude.md#455
Closed
SimonWoolf wants to merge 3 commits intomainfrom
Closed
Propose a bunch of changes to Lawrence's draft claude.md#455SimonWoolf wants to merge 3 commits intomainfrom
SimonWoolf wants to merge 3 commits intomainfrom
Conversation
This is based on having asked Claude to go through comments left by
Simon and I in all the PRs on the specification repo; hopefully this has
extracted a good amount of the team's unwritten opinions and knowledge
about how the spec should be structured. I've then tweaked it a fair bit
myself, but it's still very much Claude output that we should refine and
expand over time.
The context for writing this was that Matt O got Claude to write a spec
PR [1] for a new channel param, and was promptly told that it didn't
belong in the spec nor should the spec be specifying tests. This led him
to rightly not be very impressed by learning about the existence of a
bunch of rules that had never been written down anywhere, and suggested
that we write them down; thus this commit.
It also led to a broader conversation about feature discoverability and
testing; see [2]. The relevant parts of that conversation ("some stuff
doesn't belong in the spec but should be tracked for inclusion in these
upcoming things") have been included in the CLAUDE.md to guide people
towards the right place for ensuring that a new feature gets included in
these upcoming things even if it turns out it doesn't belong in the
spec.
I've focussed this CLAUDE.md on how to write specification points, as
opposed to describing the build system for this repo, which most people
who make spec changes never touch.
[1] #433
[2] https://ably-real-time.slack.com/archives/CURL4U2FP/p1776169126491229
Merged
Collaborator
|
Thanks Simon — no strong opinions on any of these changes, will cherry-pick to my PR |
lawrence-forooghian
force-pushed
the
AIT-530-add-claude-md
branch
2 times, most recently
from
2a18307 to
d54c748
Compare
Member
Author
|
incorporated into #454 |
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
2 participants
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.
cf #454 (comment)