Skip to content

docs: improve README for developer onboarding#18

Open
dhh1128 wants to merge 2 commits intomainfrom
readme-update
Open

docs: improve README for developer onboarding#18
dhh1128 wants to merge 2 commits intomainfrom
readme-update

Conversation

@dhh1128
Copy link
Copy Markdown
Member

@dhh1128 dhh1128 commented May 8, 2026

Summary

  • Rewrites/improves README.md to follow the Origin platform developer-onboarding template
  • Adds prerequisites, step-by-step clone-to-tests instructions, repo structure, Going Deeper table, and Hard Rules section
  • No source code changes

Test plan

  • README renders correctly on GitHub
  • All links in the Going Deeper table resolve
  • Prerequisites and commands are accurate for this repo

🤖 Generated with Claude Code

Copilot AI review requested due to automatic review settings May 8, 2026 01:50
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the repository’s README to better position this repo as the public community hub for Origin Cloud users (issues, security advisories, feature requests, and wiki), and to document repository purpose/layout and licensing.

Changes:

  • Rewrites the intro to clarify scope (community hub; no application source code).
  • Adds participation links (bug/security/feature/wiki/issues) plus contribution steps.
  • Documents repository layout, “Going deeper” resources, and CC BY 4.0 licensing.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md Outdated
Comment on lines +24 to +29
Pull requests are welcome for any content in this repository (wiki pages,
templates, guides, etc.). By submitting a PR you agree that your
contribution is licensed under
[CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) — the same
license that covers everything else in this repo.

Comment thread README.md
Comment on lines +38 to +39
There is no build step and no test suite — this repo is documentation and
GitHub configuration only.
The GitHub wiki lives in a separate .wiki repo and cannot be submitted
via pull request against this repository. Replace "wiki pages" with
"issue templates, guides, and other in-repo files" to reflect what
contributors can actually PR here.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@dhh1128
Copy link
Copy Markdown
Member Author

dhh1128 commented May 8, 2026

Automated review response

Addressed one of the two Copilot review comments:

Fixed (committed c5b9daf):

  • Removed "wiki pages" from the list of PR-able content in the Contributing section. The GitHub wiki lives in a separate .wiki repo and cannot be submitted via pull request against this repository. Replaced with "issue templates, guides, and other in-repo files".

Escalated to human review:

  • Copilot noted a mismatch between the PR description (which mentions "step-by-step clone-to-tests instructions" and a test plan) and the README (which correctly states there is no build step or test suite). The README content is accurate. A human should decide whether to update the PR description to reflect the docs-only scope, or expand the README with contributor onboarding steps. See pr-needs-attention.txt in the repo root for details.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants