Repository navigation
docs: say which checks are required, and that Codacy is advisory - #802
Merged
Merged
Conversation
A first-time contributor had no way to know what the Codacy failure means (it reports assert in tests as high-severity), that CI waits for approval on a first PR, or where design notes go. Add a section to CONTRIBUTING.md, a line to the PR template, and notes for AI coding assistants to AGENTS.md. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Up to standards ✅🟢 Issues
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #802 +/- ##
=====================================
Coverage 0.00% 0.00%
=====================================
Files 144 144
Lines 14912 14914 +2
=====================================
- Misses 14912 14914 +2 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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
1 participant
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
A first-time contributor on #791 had no way to know what the Codacy failure means (it reports
assertin tests as "high" security), that CI waits for approval on a first PR, or where design notes go. Their PR also added a rootmobile-desiderata.mdbecause an Issue named a private file..github/CONTRIBUTING.md: new sections AI-assisted contributions, What the checks mean (required vs advisory, first-PR approval, flaky timeouts) and Where things go; branch namingtype/short-description..github/pull_request_template.md: two checklist lines (Codacy is advisory; AI assistance disclosed).AGENTS.md: a section for AI assistants preparing a contribution (disclose in the PR, keep theCo-Authored-Bytrailer, no root files, don't invent files named in an Issue).Documentation only, no code.
Related issue
Arose from #791.
🤖 Generated with Claude Code