docs: agree on public API changes before implementing them - #273
Open
turnipdabeets wants to merge 1 commit into
Open
docs: agree on public API changes before implementing them#273turnipdabeets wants to merge 1 commit into
turnipdabeets wants to merge 1 commit into
Conversation
posthog-ruby Compliance ReportDate: 2026-09-11 15:27:24 UTC ✅ All Tests Passed!46/46 tests passed Capture Tests✅ 29/29 tests passed View Details
Feature_Flags Tests✅ 17/17 tests passed View Details
|
turnipdabeets
marked this pull request as ready for review
September 11, 2026 17:17
Contributor
Prompt To Fix All With AI### Issue 1
CONTRIBUTING.md:52
**Public constants are omitted**
The approval requirement lists public options, methods, and types but omits public constants, even though the API snapshot explicitly tracks them. Contributors changing constants may therefore assume that prior agreement is unnecessary. Include public constants in this list.
```suggestion
- If you need something the SDK doesn't support and it would add or change a public option, method, type, or constant, open an issue describing your use case first. At this stage, context is more useful to us than code.
```
---
For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.Reviews (1): Last reviewed commit: "docs: agree on public API changes before..." | Re-trigger Greptile |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
|
|
||
| Public API is hard to change once it ships, so agree on it before writing the implementation. Our [SDK guidelines](https://posthog.com/handbook/engineering/sdks/guidelines) explain how we design it. | ||
|
|
||
| - If you need something the SDK doesn't support and it would add or change a public option, method, or type, open an issue describing your use case first. At this stage, context is more useful to us than code. |
Contributor
There was a problem hiding this comment.
The approval requirement lists public options, methods, and types but omits public constants, even though the API snapshot explicitly tracks them. Contributors changing constants may therefore assume that prior agreement is unnecessary. Include public constants in this list.
Suggested change
| - If you need something the SDK doesn't support and it would add or change a public option, method, or type, open an issue describing your use case first. At this stage, context is more useful to us than code. | |
| - If you need something the SDK doesn't support and it would add or change a public option, method, type, or constant, open an issue describing your use case first. At this stage, context is more useful to us than code. |
Prompt To Fix With AI
This is a comment left during a code review.
Path: CONTRIBUTING.md
Line: 52
Comment:
**Public constants are omitted**
The approval requirement lists public options, methods, and types but omits public constants, even though the API snapshot explicitly tracks them. Contributors changing constants may therefore assume that prior agreement is unnecessary. Include public constants in this list.
```suggestion
- If you need something the SDK doesn't support and it would add or change a public option, method, type, or constant, open an issue describing your use case first. At this stage, context is more useful to us than code.
```
---
For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
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.
💡 Motivation and Context
Port of PostHog/posthog-js#4906 to posthog-ruby.
On contributor PRs we sometimes only settle the public API after several rounds of implementation review. By then the contributor, or their agent, has built each suggestion along the way, and a late change of direction wastes their work. This asks contributors to agree on the API shape on the issue first, and tells their agents to stop and ask.
CONTRIBUTING.md: new "Public API changes" section, same as posthog-js. Placed before "Rails package". The last paragraph refers back to the snapshot steps already in "CI-aligned checks" rather than repeating them.AGENTS.md: new file, since this repo didn't have one. Same shape as the posthog-js one: it points agents toCONTRIBUTING.md,RELEASING.md, and the new section, and asks to keep shared guidance out ofAGENTS.md.💚 How did you test it?
Docs only. Checked that the commands and file paths it mentions exist in this repo.
📝 Checklist
If releasing new changes
pnpm changesetto generate a changeset file🤖 Agent context
Autonomy: Human-driven (agent-assisted)
beforeSend-style hook name to this SDK.🤖 Generated with Claude Code
https://claude.ai/code/session_016syAmdpp8imNvs7PWkpwvb