Skip to content

Refresh README/CONTRIBUTING and add AGENTS.md - #1

Merged
pietervw merged 2 commits into
mainfrom
docs/readme-and-agents
Jul 28, 2026
Merged

Refresh README/CONTRIBUTING and add AGENTS.md#1
pietervw merged 2 commits into
mainfrom
docs/readme-and-agents

Conversation

@pietervw

Copy link
Copy Markdown
Owner

Summary

  • Refresh README and CONTRIBUTING docs
  • Add AGENTS.md and small C# demo polish

Test plan

  • Skim README for accuracy
  • Confirm C# demo still builds/runs

Clarify demo usage and agent conventions for contributors.

Co-authored-by: Cursor <cursoragent@cursor.com>
@coderabbitai

coderabbitai Bot commented Jul 28, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@pietervw, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 1 minute

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: ce5608c3-ed22-46d4-9f78-e85d210c398e

📥 Commits

Reviewing files that changed from the base of the PR and between 62b5b61 and 48c9ce9.

📒 Files selected for processing (5)
  • AGENTS.md
  • CONTRIBUTING.md
  • README.md
  • csharp/Program.cs
  • typescript/health.ts
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/readme-and-agents

Comment @coderabbitai help to get the list of available commands.

@pietervw

Copy link
Copy Markdown
Owner Author

@codex review

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 43dcc27eb6

ℹ️ 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".

Comment thread README.md
```

Per-language loading behavior:
- **Node.js / TypeScript**: these samples import `dotenv/config` and read `.env` from the current working directory.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Load .env in the TypeScript health sample

When a user sets a non-default NPI_API_BASE_URL only in typescript/.env and runs npx tsx health.ts as instructed, typescript/health.ts does not import dotenv/config, so it silently checks the default production host instead. Either add the import to that sample or exclude it from this loading claim.

Useful? React with 👍 / 👎.

Comment thread AGENTS.md Outdated
# AGENTS.md

## Shared coding quality expectations
- Reference: [Personal coding heuristics](C:/git/personal-ai/memory/coding-heuristics.md)

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Check in the heuristics required by AGENTS

In a fresh clone—or on any machine without the author's C:/git/personal-ai directory—the required heuristics cannot be opened, and a repo-wide search confirms that no copy is included here. Because the next line makes reading them a prerequisite to coding, contributors and agents cannot comply; use a repository-relative, committed document instead.

AGENTS.md reference: AGENTS.md:L4-L5

Useful? React with 👍 / 👎.

Co-authored-by: Cursor <cursoragent@cursor.com>
@pietervw
pietervw merged commit 6a5d765 into main Jul 28, 2026
3 of 5 checks passed
@pietervw
pietervw deleted the docs/readme-and-agents branch August 9, 2026 21:59
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