Skip to content

Comments

docs: add CODEOWNERS, CONTRIBUTING, and AGENTS development guides#73

Merged
jdhoffa merged 3 commits intomainfrom
root_mds
Feb 20, 2026
Merged

docs: add CODEOWNERS, CONTRIBUTING, and AGENTS development guides#73
jdhoffa merged 3 commits intomainfrom
root_mds

Conversation

@jdhoffa
Copy link
Owner

@jdhoffa jdhoffa commented Feb 20, 2026

This PR adds repository governance and contributor/agent guidance files:

  • .github/CODEOWNERS: Sets @jdhoffa as code owner for the full repository.
  • CONTRIBUTING.md: Adds contribution process guidance (issues/discussions, PR expectations, testing/docs requirements, code ownership review expectations, and issue-prefixed
    branch naming convention).
  • AGENTS.md: Adds repository-specific instructions for coding agents (commands, directory structure, workflow expectations, issue/PR behavior).

Copilot AI review requested due to automatic review settings February 20, 2026 12:17
@github-actions
Copy link
Contributor

github-actions bot commented Feb 20, 2026

Docs preview was removed because this PR is closed.

@jdhoffa jdhoffa merged commit 86de6b1 into main Feb 20, 2026
7 checks passed
@jdhoffa jdhoffa deleted the root_mds branch February 20, 2026 12:18
github-actions bot added a commit that referenced this pull request Feb 20, 2026
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR establishes repository governance and development guidelines by adding three foundational documentation files. The changes provide clear expectations for contributors and coding agents, define code ownership, and establish process conventions for issues, PRs, and commits.

Changes:

  • Added CODEOWNERS file designating @jdhoffa as owner for all repository files
  • Added CONTRIBUTING.md with contribution guidelines covering issue/PR workflow, testing, documentation requirements, and commit conventions
  • Added AGENTS.md with agent-specific development instructions including commands, directory structure, and workflow expectations

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

File Description
.github/CODEOWNERS Sets @jdhoffa as code owner requiring review approval for all changes
CONTRIBUTING.md Defines contribution process, coding standards, branch/commit conventions, and documentation requirements
AGENTS.md Provides coding agent guidance on commands, repository structure, and development workflow

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.


## Commit and Branch Guidance

- Branch names: prefix with the GitHub issue number when appropriate, then a short descriptor (e.g., `23-http_telemetry_range`).
Copy link

Copilot AI Feb 20, 2026

Choose a reason for hiding this comment

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

The branch naming example uses mixed separators: a hyphen between the issue number and descriptor (23-) but underscores within the descriptor (http_telemetry_range). For consistency, consider using hyphens throughout (e.g., 23-http-telemetry-range) or explicitly state that underscores should be used within descriptors while hyphens separate the issue number.

Suggested change
- Branch names: prefix with the GitHub issue number when appropriate, then a short descriptor (e.g., `23-http_telemetry_range`).
- Branch names: prefix with the GitHub issue number when appropriate, then a short descriptor using hyphens as separators (e.g., `23-http-telemetry-range`).

Copilot uses AI. Check for mistakes.
- Simulation logic: `src/sim/`
- Integration tests: `tests/`
- CI workflows: `.github/workflows/`
- Project documentation: `README.md`, `docs/`, `CONTRIBUTING.md`
Copy link

Copilot AI Feb 20, 2026

Choose a reason for hiding this comment

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

The reference to docs/ directory is incorrect. The repository does not have a docs/ directory. The documentation is generated from Rustdoc (as shown in .github/workflows/docs.yml) and deployed to GitHub Pages, not stored in a docs directory. Consider removing this reference or clarifying that documentation refers to Rustdoc comments in source files.

Suggested change
- Project documentation: `README.md`, `docs/`, `CONTRIBUTING.md`
- Project documentation: `README.md`, Rustdoc comments in `src/`, `CONTRIBUTING.md` (Rustdoc-generated API docs are published via GitHub Pages)

Copilot uses AI. Check for mistakes.
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