clarify processes and recommendations - #194
Conversation
|
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (4)
✅ Files skipped from review due to trivial changes (1)
🚧 Files skipped from review as they are similar to previous changes (2)
📝 WalkthroughWalkthroughThis PR updates repository documentation to clarify branching and release workflow: designates Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
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 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 |
There was a problem hiding this comment.
Pull request overview
This PR updates the repository documentation to clarify how downstream consumers should use published lexicon releases (rather than raw repo branches) and to better describe the branch/release workflow for contributors and AI agents.
Changes:
- Add clearer guidance in
README.mdandAGENTS.mdfor consuming lexicons via npm releases or GitHub tags. - Refine and expand branch strategy / release flow documentation in
docs/PUBLISHING.mdand related contributor guidance. - Restructure/rephrase contributing and project-structure documentation across the main docs.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| README.md | Adds “Consuming These Lexicons” + clarifies branch usage and contribution pointers. |
| docs/PUBLISHING.md | Refines branch strategy wording and flow documentation for releases/prereleases. |
| CONTRIBUTING.md | Updates PR targeting guidance to allow prerelease/* when needed. |
| AGENTS.md | Aligns AI-agent guidance with updated branch strategy and downstream-consumption recommendations. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
README.md (1)
83-83: Optional: Consider hyphenating "3rd-party".Static analysis suggests hyphenating compound adjectives like "3rd-party systems". This is a stylistic preference rather than an error—the current form is acceptable.
✍️ Optional style improvement
-involve several moving parts (including 3rd party systems), and it is technically +involve several moving parts (including 3rd-party systems), and it is technically🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` at line 83, Update the README phrase "3rd party systems" to the hyphenated form "3rd-party systems" to follow compound-adjective styling; locate the occurrence in the README content where the sentence contains "3rd party systems" and replace it with "3rd-party systems".
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@AGENTS.md`:
- Around line 19-37: Replace the misspelled word "targetting" with the correct
spelling "targeting" in the AGENTS.md branch description (the bullet mentioning
"**`feature/*` (or `fix/*`) branches**") and make the same correction in any
other docs with the same typo (e.g., docs/PUBLISHING.md) to keep wording
consistent.
In `@docs/PUBLISHING.md`:
- Around line 13-27: Replace the misspelled word "targetting" with the correct
spelling "targeting" in the docs/PUBLISHING.md section that describes branch
types (the line containing "`feature/*` (or `fix/*`) branches: ... targetting
and merged to `main` or a `prerelease/*` branch via PR"). Ensure only the word
is changed and surrounding punctuation and markup (backticks, branch names)
remain unchanged.
---
Nitpick comments:
In `@README.md`:
- Line 83: Update the README phrase "3rd party systems" to the hyphenated form
"3rd-party systems" to follow compound-adjective styling; locate the occurrence
in the README content where the sentence contains "3rd party systems" and
replace it with "3rd-party systems".
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 0421d6f0-e622-4a5b-8121-4587f4a25989
📒 Files selected for processing (4)
AGENTS.mdCONTRIBUTING.mdREADME.mddocs/PUBLISHING.md
3ad4d04 to
def3534
Compare
def3534 to
2eed101
Compare
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Around line 55-56: The phrase "building an downstream application" uses the
wrong indefinite article; update the sentence in the README where it reads "If
you are building an downstream application on top of these lexicons" to use "a
downstream" instead of "an downstream" so it reads "If you are building a
downstream application on top of these lexicons."
- Around line 128-129: Replace the phrase "3rd party systems" with the
hyphenated compound adjective "3rd-party systems" in the README text snippet
containing "moving parts (including 3rd party systems), and it is technically
impossible to update all three at the same time." to improve readability; search
for the literal "3rd party systems" and update it to "3rd-party systems".
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 6b431b87-131b-44c9-beb8-e4183de170fb
📒 Files selected for processing (4)
AGENTS.mdCONTRIBUTING.mdREADME.mddocs/PUBLISHING.md
✅ Files skipped from review due to trivial changes (1)
- CONTRIBUTING.md
🚧 Files skipped from review as they are similar to previous changes (1)
- AGENTS.md
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 4 out of 4 changed files in this pull request and generated 5 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
2eed101 to
6c54a03
Compare
6c54a03 to
6c19186
Compare
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
ae3355c to
594ad69
Compare
594ad69 to
dfea2bb
Compare
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
dfea2bb to
e4eab4b
Compare
e4eab4b to
4938fe9
Compare
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 4 out of 4 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Make it clearer how we use branches and do releases, and give specific
recommendations to humans and AI agents for the best ways to a) build
apps on top of the lexicons and b) contribute to them.
Summary by CodeRabbit