Skip to content

docs(A21): add work-state header to README#246

Open
KooshaPari wants to merge 3 commits into
mainfrom
docs/A21-readme-workstate
Open

docs(A21): add work-state header to README#246
KooshaPari wants to merge 3 commits into
mainfrom
docs/A21-readme-workstate

Conversation

@KooshaPari

@KooshaPari KooshaPari commented Jun 25, 2026

Copy link
Copy Markdown
Owner

User description

Summary

Add org-convention work-state header blockquote to README.md and replace the verbose ## Work state section.

Context

BytePort's README was missing the phenotype-org > **Work state:** blockquote that is checked by conventions-lint.sh. The existing ## Work state heading section was verbose and not at the top of the file where the linter expects it.

Changes

  • Insert > **Work state:** ACTIVE · **Progress:** \█████████░ 90%`blockquote right after, matching the canonical pattern used by phenotype-registry/README.md:22`
  • Remove the redundant ## Work state table section (13 lines) which duplicated information now captured in the blockquote + STATUS.md

Testing

# Verify conventions-lint passes the work-state header check
head -n 8 README.md | grep "Work state:"  # should match

Links

  • Reference: phenotype-registry/scripts/conventions-lint.sh:30 (org convention check)
  • Canonical: phenotype-registry/README.md:22

CodeAnt-AI Description

Add the required work-state header to the README

What Changed

  • Added the Work state status line near the top of the README so it matches the expected project convention
  • Kept the rest of the document structure unchanged

Impact

✅ README now meets the expected work-state format
✅ Clearer project status at a glance
✅ Fewer convention check failures

💡 Usage Guide

Checking Your Pull Request

Every time you make a pull request, our system automatically looks through it. We check for security issues, mistakes in how you're setting up your infrastructure, and common code problems. We do this to make sure your changes are solid and won't cause any trouble later.

Talking to CodeAnt AI

Got a question or need a hand with something in your pull request? You can easily get in touch with CodeAnt AI right here. Just type the following in a comment on your pull request, and replace "Your question here" with whatever you want to ask:

@codeant-ai ask: Your question here

This lets you have a chat with CodeAnt AI about your pull request, making it easier to understand and improve your code.

Example

@codeant-ai ask: Can you suggest a safer alternative to storing this secret?

Preserve Org Learnings with CodeAnt

You can record team preferences so CodeAnt AI applies them in future reviews. Reply directly to the specific CodeAnt AI suggestion (in the same thread) and replace "Your feedback here" with your input:

@codeant-ai: Your feedback here

This helps CodeAnt AI learn and adapt to your team's coding style and standards.

Example

@codeant-ai: Do not flag unused imports.

Retrigger review

Ask CodeAnt AI to review the PR again, by typing:

@codeant-ai: review

Check Your Repository Health

To analyze the health of your code repository, visit our dashboard at https://app.codeant.ai. This tool helps you identify potential issues and areas for improvement in your codebase, ensuring your repository maintains high standards of code health.

@KooshaPari KooshaPari added the area:compute-infra Phenotype compute/infra epic label Jun 25, 2026
@gemini-code-assist

Copy link
Copy Markdown

Warning

You have reached your daily quota limit. Please wait up to 24 hours and I will start processing your requests again!

@codeant-ai

codeant-ai Bot commented Jun 25, 2026

Copy link
Copy Markdown

CodeAnt AI is reviewing your PR.

@codeant-ai

codeant-ai Bot commented Jun 25, 2026

Copy link
Copy Markdown

Thanks for using CodeAnt! 🎉

We're free for open-source projects. if you're enjoying it, help us grow by sharing.

Share on X ·
Reddit ·
LinkedIn

@github-actions

Copy link
Copy Markdown

Legacy Tooling Scan Report

Severity Count
Critical 0
High 0
Medium 0
Low 0

No violations detected.

This is a WARN-mode scan. Fix before strict enforcement begins.

@codeant-ai codeant-ai Bot added the size:XS This PR changes 0-9 lines, ignoring generated files label Jun 25, 2026
@codeant-ai

codeant-ai Bot commented Jun 25, 2026

Copy link
Copy Markdown

CodeAnt AI finished reviewing your PR.

@github-actions

Copy link
Copy Markdown

Legacy Tooling Scan Report

Severity Count
Critical 0
High 0
Medium 0
Low 0

No violations detected.

This is a WARN-mode scan. Fix before strict enforcement begins.

@sonarqubecloud

Copy link
Copy Markdown

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:compute-infra Phenotype compute/infra epic size:XS This PR changes 0-9 lines, ignoring generated files

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant