Skip to content

docs: add CONTRIBUTING.md#16

Open
okwn wants to merge 1 commit into
agentmail-to:mainfrom
okwn:docs/add-contributing
Open

docs: add CONTRIBUTING.md#16
okwn wants to merge 1 commit into
agentmail-to:mainfrom
okwn:docs/add-contributing

Conversation

@okwn
Copy link
Copy Markdown

@okwn okwn commented May 22, 2026

Summary

Adds CONTRIBUTING.md with development setup and process documentation.

Testing

N/A — documentation only.


Summary by cubic

Adds a streamlined CONTRIBUTING.md with quick setup and PR steps, and adds internal docs to map the repo, surface issues, and outline a short-term PR plan.

  • Documentation
    • Simplified CONTRIBUTING.md with clone/install/test steps, code style, PR flow, and issue reporting; standardized commands to npm.
    • Added 00_STATE.md (repo overview: structure, CI, tests, open issues).
    • Added 01_REPO_MAP.md (exports map and source/test layout).
    • Added 05_PR_CANDIDATES.md (key issues, lint findings, proposed PRs).
    • Added 06_SELECTED_5_PR_PLAN.md (prioritized PR plan and order).

Written for commit 9fc37c6. Summary will update on new commits. Review in cubic

Copy link
Copy Markdown

@cubic-dev-ai cubic-dev-ai Bot left a comment

Choose a reason for hiding this comment

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

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

Comment thread CONTRIBUTING.md
- pnpm package manager
2. Install dependencies:
```sh
npm install
Copy link
Copy Markdown

@cubic-dev-ai cubic-dev-ai Bot May 22, 2026

Choose a reason for hiding this comment

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

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
Fix with Cubic

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.

1 participant