[RORDEV-2220] add branching, code style and writing style docs - #125
Merged
Conversation
Port of two ES repo PRs and their Kibana repo port: - sscarduzio/elasticsearch-readonlyrest-plugin#1379 - sscarduzio/elasticsearch-readonlyrest-plugin#1377 - sscarduzio/readonlyrest_kbn#1032 docs/dev/branching.md says what master and develop test, which branch a PR targets, and how a change reaches the other branch. docs/dev/code-style.md says that a comment explains the current state, not the change that made it. docs/dev/writing-style.md gives the language rule for every text we write about the code. CLAUDE.md is new. It describes the layout and links the three files. README.md links them under Development.
This comment was marked as spam.
This comment was marked as spam.
This was referenced Sep 10, 2026
This comment was marked as outdated.
This comment was marked as outdated.
![10hexdev[bot]](https://avatars.githubusercontent.com/in/4780969?s=60&v=4){kind=small}
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
The avoid list in CLAUDE.md put yarn.lock next to node_modules under "generated". The lockfile is committed and reviewed; it is only large. Split the two, and say how to read the lockfile. branching.md said the prod suite runs on every PR that targets master. The job also requires a non-fork head. Case 6 covered only the docs that describe the released setup, which left the process docs — this file among them — targeting develop. The comment the code-style example quotes did not exist. Put it at the guard it describes. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01UWNGUC1RURtKWt7KKf44jM
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
Dzuming
approved these changes
Sep 11, 2026
Dzuming
left a comment
Dzuming
left a comment
Collaborator
There was a problem hiding this comment.
LGTM i left one small comment,
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
3 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.
Port of two ES repo PRs and their Kibana repo port:
New files under
docs/dev/:branching.md—mastertests the released plugins,developtests the branch-matched dev images. It names the six cases that targetmasterand the merges between the two branches. The case list comes from the merged PRs of this repo.code-style.md— a comment explains the current state, not the change that made it. Where a comment goes, and what deserves one. The examples use our workflow file and our Kibana version guards.writing-style.md— Simplified Technical English (ASD-STE100) plus Zinsser.CLAUDE.mdis new; this repo had none. It gives the layout, the checks, and the three links.README.mdlinks the three files under Development.The source PRs also change a review checklist and two skills. This repo has neither, so those edits have no target here.