Add Contributing Guide#32
Conversation
Move shared contribution guidance into CONTRIBUTING.md and keep AGENTS.md focused on AI-agent workflow. Document issue handling, validation, code conventions, and AI policy references. Assisted-by: Codex:gpt-5.5
Run formatting, Clippy, and workspace tests for pushes and pull requests targeting main. Assisted-by: Codex:gpt-5.5
Document concrete workflows for documentation-only changes, query syntax updates, resolver behavior, SQLite planning, and AI-assisted work. Assisted-by: Codex:gpt-5.5
|
@codex review |
![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: 8cd919e1fd
ℹ️ 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".
| Commits that include Codex-assisted design, implementation, review, or | ||
| documentation must include this trailer: | ||
|
|
||
| ```text | ||
| Assisted-by: Codex:gpt-5.5 |
There was a problem hiding this comment.
This Codex-authored commit marks AI assistance in the commit message body but does not include the required Git trailer. Because AI_POLICY.md already required Assisted-by trailers and this new guide repeats that requirement, merging this commit as-is leaves the repository history non-compliant; please add the Assisted-by: Codex:gpt-5.5 trailer to the commit message.
Useful? React with 👍 / 👎.
| acceptance criteria. | ||
| 3. Relevant `spec/` documents. | ||
| 4. Relevant `plan/` documents. | ||
| 5. The current conversation. |
There was a problem hiding this comment.
With the current conversation ranked below repository docs, future agents are instructed to ignore explicit maintainer scope changes whenever they conflict with AGENTS/CONTRIBUTING/specs. For non-issue or follow-up tasks such as review only, do not edit files, or skip this validation, this reverses the previous AGENTS rule that put the current user instruction first and can lead agents to perform work the maintainer just ruled out.
Useful? React with 👍 / 👎.
| This file is for AI agents working in this repository. Human and AI | ||
| contributors should use [CONTRIBUTING.md](CONTRIBUTING.md) as the main | ||
| contribution guide and [AI_POLICY.md](AI_POLICY.md) as the policy for |
There was a problem hiding this comment.
When AGENTS.md was reduced to a pointer document, the existing Review expectations section was not carried into CONTRIBUTING.md or the new AGENTS.md. For future @codex review tasks this removes the repo-specific instruction to prioritize spec mismatches, crate boundary leaks, semantic/cardinality bugs, and weak tests, so automated reviews will regress to generic guidance unless that rubric is restored or linked here.
Useful? React with 👍 / 👎.
Prioritize explicit maintainer constraints without weakening repository contracts, and restore the repository-specific review rubric. Assisted-by: Codex:gpt-5.5
|
1 participant
Summary
CONTRIBUTING.mdCloses #30
Scope
CONTRIBUTING.md./githubAI_POLICY.mdSpec and plan alignment
Tests
List the automated and manual checks performed.
cargo test --workspaceReview notes
AI assistance
Disclose AI tool usage according to
AI_POLICY.md.messages with
Assisted-bytrailers.Tools and models: