Repository navigation
docs: add a contributing guide and write test perspectives in English - #122
Conversation
- Add CONTRIBUTING.md covering the development setup, the checks CI runs, the code conventions in short, and where user-facing text lives in both languages - Ask contributors to list copied or adapted code in ThirdPartyNotices.txt, since the minified build drops source comments - State that the test perspective documents, CHANGELOG.md, and the version are kept up to date by the maintainer, so contributors do not need to touch them - Link the guide from the Contributing section of the README
|
Warning Review limit reachedYou've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. Next included review available in 37 minutes. View limit details
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 |
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
There was a problem hiding this comment.
🔍 Devin Review: 1 flag
Not posted on this PR by your GitHub settings — view it in Devin Review. (Configure)
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: ea7d12f093
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
Background and purpose
#114 was the first pull request from outside the project, and it showed where a contributor gets stuck: the test perspective documents are mostly in Japanese, their
INDEX.mdis regenerated by tooling that is not in the repository, and notices for adapted code have to reach the packaged extension. This PR gives contributors one place to read before they start, and makes new perspective entries English.Changes
CONTRIBUTING.md: development setup (WSL on Windows, Node.js 22, pnpm through Corepack,F5to run), the checks CI runs, the code conventions in short, where user-facing text lives in English and Japanese, and how to credit code from other projects inThirdPartyNotices.txtCONTRIBUTING.mdthat the test perspective documents,CHANGELOG.md, and the version are kept up to date by the maintainer, so contributors can leave them aloneAGENTS.md: test perspective documents are written in English from now on. Existing Japanese sections stay until they are rewrittenCONTRIBUTING.mdfrom the Contributing section of the READMEPoints to review
CONTRIBUTING.md"User-facing text"AGENTS.md"Testing"