Conversation
|
Docs preview was removed because this PR is closed. |
There was a problem hiding this comment.
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
@jdhoffaas 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`). |
There was a problem hiding this comment.
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.
| - 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`). |
| - Simulation logic: `src/sim/` | ||
| - Integration tests: `tests/` | ||
| - CI workflows: `.github/workflows/` | ||
| - Project documentation: `README.md`, `docs/`, `CONTRIBUTING.md` |
There was a problem hiding this comment.
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.
| - 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) |
This PR adds repository governance and contributor/agent guidance files:
branch naming convention).