docs: split CONTRIBUTING.md into contributor and development guides#7
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR reorganizes the project documentation by splitting CONTRIBUTING.md into two focused documents: a contributor-focused guide (CONTRIBUTING.md) and a development-focused guide (DEVELOPMENT.md).
Changes:
- Creates DEVELOPMENT.md with comprehensive development setup, architecture overview, make targets reference, and debugging guides
- Refactors CONTRIBUTING.md to focus on contribution guidelines, design principles, PR process, and DCO requirements
- Updates .claude/CLAUDE.md to document the new documentation structure
- Removes duplicate content (tool setup, project architecture) that now lives in DEVELOPMENT.md
- Adds bidirectional cross-references between CONTRIBUTING.md and DEVELOPMENT.md for easy navigation
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| DEVELOPMENT.md | New comprehensive development guide covering setup, architecture, make targets, and debugging |
| CONTRIBUTING.md | Streamlined to focus on contribution process, design principles, and DCO requirements |
| .claude/CLAUDE.md | Updated to document the new documentation structure with separate entries for CONTRIBUTING.md and DEVELOPMENT.md |
Split the 633-line CONTRIBUTING.md into two focused documents: **CONTRIBUTING.md (~310 lines)** - Contribution guidelines: - Code of Conduct - How to Contribute (bugs, features, docs, code) - Design Principles (all 6 principles) - Pull Request Process - Developer Certificate of Origin (DCO) - Tips for Contributors **DEVELOPMENT.md (~500 lines)** - Development setup and architecture: - Quick Start - Prerequisites (with Linux-specific setup for Ubuntu 24.04+) - Development Setup and Version Management - Project Architecture (CLI, API Server, Collectors, Recipe Engine, Snapshotter, Bundler Framework, Validator) - Development Workflow - Local Kubernetes Development (Kind, Tilt) - Make Targets Reference (all targets verified against Makefile) - Debugging guide Changes based on testing in a fresh Ubuntu 24.04 VM: - Clarify that `make` needs installation on minimal Linux images - Add `yq` to required tools (needed by make tools-setup/check) - Add `addlicense` to development tools list - Add Linux-Specific Setup section for PEP 668 compatibility - List all four CLI commands: snapshot, recipe, bundle, validate Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> Signed-off-by: Davanum Srinivas <dsrinivas@nvidia.com>
dims
force-pushed
the
docs/split-contributing-development
branch
from
af1c768 to
c7f0ad5
Compare
8 tasks
3 tasks
Contributor
|
This pull request has been automatically locked since it has been closed for 90 days with no further activity. Please open a new pull request for related changes. |
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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
Split CONTRIBUTING.md into two focused documents: CONTRIBUTING.md for contribution guidelines and DEVELOPMENT.md for development setup and architecture.
Motivation / Context
The original CONTRIBUTING.md was 633 lines covering both contribution guidelines and development setup. This made it harder for:
Splitting into two documents improves discoverability and follows patterns seen in other NVIDIA projects (e.g., nvsentinel).
Fixes: N/A
Related: N/A
Type of Change
Component(s) Affected
cmd/eidos,pkg/cli)cmd/eidosd,pkg/api,pkg/server)pkg/recipe)pkg/bundler,pkg/component/*)pkg/collector,pkg/snapshotter)pkg/validator)pkg/errors,pkg/k8s)docs/,examples/)Implementation Notes
CONTRIBUTING.md (~310 lines) now focuses on:
DEVELOPMENT.md (~480 lines) now contains:
Verification performed:
Testing
Risk Assessment
Rollout notes: N/A - documentation only, no migration needed
Checklist
make testwith-race)make lint)git commit -s) — DCO info