Skip to content

docs: add CONTRIBUTING.md#9

Open
okwn wants to merge 3 commits into
agentmail-to:mainfrom
okwn:docs/add-contributing
Open

docs: add CONTRIBUTING.md#9
okwn wants to merge 3 commits 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

Add CONTRIBUTING.md with setup, testing, linting, and PR guidelines. Also add an MIT LICENSE and fix minor ruff import-order issues to keep CI clean.

  • Documentation

    • Added CONTRIBUTING.md covering Poetry setup, pytest, ruff, mypy, and PR steps.
    • Added MIT LICENSE file.
    • Added internal docs for repository state, map, PR candidates, and selected plan.
  • Bug Fixes

    • Fixed ruff I001 import order in src/agentmail/core/query_encoder.py and tests/utils/test_query_encoding.py.

Written for commit f064ec8. 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 8 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="05_PR_CANDIDATES.md">

<violation number="1" location="05_PR_CANDIDATES.md:60">
P2: Documentation recommends editing auto-generated files without warning about the Fern generation workflow, creating a futile-edit maintainability risk.</violation>
</file>

Reply with feedback, questions, or to request a fix.

Fix all with cubic | Re-trigger cubic

Comment thread 05_PR_CANDIDATES.md
| Lint | ⚠️ | 2 fixable ruff issues (import sorting) |
| License | ⚠️ | pyproject.toml says MIT but no LICENSE file found |

## Ruff Issues Found
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: Documentation recommends editing auto-generated files without warning about the Fern generation workflow, creating a futile-edit maintainability risk.

Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At 05_PR_CANDIDATES.md, line 60:

<comment>Documentation recommends editing auto-generated files without warning about the Fern generation workflow, creating a futile-edit maintainability risk.</comment>

<file context>
@@ -0,0 +1,62 @@
+| Lint | ⚠️ | 2 fixable ruff issues (import sorting) |
+| License | ⚠️ | pyproject.toml says MIT but no LICENSE file found |
+
+## Ruff Issues Found
+1. `src/agentmail/core/query_encoder.py` - unsorted imports
+2. `tests/utils/test_query_encoding.py` - unsorted imports
</file context>
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