docs: add CONTRIBUTING.md#16
Open
okwn wants to merge 1 commit into
Open
Conversation
There was a problem hiding this comment.
1 issue found across 5 files
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="CONTRIBUTING.md">
<violation number="1" location="CONTRIBUTING.md:15">
P2: CONTRIBUTING.md prescribes npm commands that conflict with the project's pnpm configuration</violation>
</file>
Reply with feedback, questions, or to request a fix.
Fix all with cubic | Re-trigger cubic
| - pnpm package manager | ||
| 2. Install dependencies: | ||
| ```sh | ||
| npm install |
There was a problem hiding this comment.
P2: CONTRIBUTING.md prescribes npm commands that conflict with the project's pnpm configuration
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At CONTRIBUTING.md, line 15:
<comment>CONTRIBUTING.md prescribes npm commands that conflict with the project's pnpm configuration</comment>
<file context>
@@ -1,133 +1,40 @@
-- pnpm package manager
+2. Install dependencies:
+ ```sh
+ npm install
+ ```
</file context>
Suggested change
| npm install | |
| pnpm install |
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
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.
Summary
Adds CONTRIBUTING.md with development setup and process documentation.
Testing
N/A — documentation only.
Summary by cubic
Adds a streamlined
CONTRIBUTING.mdwith quick setup and PR steps, and adds internal docs to map the repo, surface issues, and outline a short-term PR plan.CONTRIBUTING.mdwith clone/install/test steps, code style, PR flow, and issue reporting; standardized commands tonpm.00_STATE.md(repo overview: structure, CI, tests, open issues).01_REPO_MAP.md(exports map and source/test layout).05_PR_CANDIDATES.md(key issues, lint findings, proposed PRs).06_SELECTED_5_PR_PLAN.md(prioritized PR plan and order).Written for commit 9fc37c6. Summary will update on new commits. Review in cubic