Initialize contribution area #396
Conversation
There was a problem hiding this comment.
Pull request overview
This PR initializes a contrib/ area to serve as an incubator for experimental integrations, third-party recipes, and work-in-progress features that aren't ready for the main codebase. The contrib area provides a structured space for community contributions while maintaining clear ownership and documentation standards.
- Adds
contrib/directory structure with namespace packages, READMEs, and placeholder files - Updates Pyright configuration to exclude contrib area from type checking
- Documents contrib guidelines and submission checklist in contributing guide
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| pyrightconfig.json | Excludes contrib/** from type checking |
| pyrightconfig.fast.json | Adds contrib/** to the fast check exclusion list |
| docs/community/contributing.md | Adds comprehensive "Agent-lightning Contrib" section explaining when and how to contribute to the contrib area |
| contrib/agentlightning/contrib/init.py | Creates namespace package for contrib extensions |
| contrib/README.md | Provides directory structure overview and submission checklist for contrib area |
| contrib/CODEOWNERS | Placeholder file for code ownership definitions |
| contrib/.gitignore | Placeholder file for contrib-specific gitignore patterns |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
docs/community/contributing.md
Outdated
|
|
||
| A quick checklist for contributions to be accepted: | ||
|
|
||
| 1. **Document everything.** Include configuration steps, environment variables, and sample commands so contributors an reproduce the results without guesswork. |
There was a problem hiding this comment.
Typo: "contributors an reproduce" should be "contributors can reproduce".
| 1. **Document everything.** Include configuration steps, environment variables, and sample commands so contributors an reproduce the results without guesswork. | |
| 1. **Document everything.** Include configuration steps, environment variables, and sample commands so contributors can reproduce the results without guesswork. |
contrib/README.md
Outdated
| ## Directory map | ||
|
|
||
| - `agentlightning/` — Namespace packages, utilities, and adapters that extend the published wheel. Place new code under `agentlightning/contrib/<feature>/` so `import agentlightning.contrib.<feature>` works for downstream users. | ||
| - `recipes/` — Task-focused example bundles that solves a specific problem and derives certain results. Each recipe belongs in its own directory with a README that documents usage, result reports, and ownership. |
There was a problem hiding this comment.
Grammar issue: "that solves a specific problem and derives certain results" should use singular "solves" with plural "bundles" is incorrect. Consider: "Task-focused example bundles that solve a specific problem and derive certain results" or restructure to "Task-focused example bundle that solves..."
| - `recipes/` — Task-focused example bundles that solves a specific problem and derives certain results. Each recipe belongs in its own directory with a README that documents usage, result reports, and ownership. | |
| - `recipes/` — Task-focused example bundles that solve a specific problem and derive certain results. Each recipe belongs in its own directory with a README that documents usage, result reports, and ownership. |
contrib/CODEOWNERS
Outdated
| @@ -0,0 +1 @@ | |||
| # Put code owner definitions in the file. | |||
There was a problem hiding this comment.
[nitpick] The comment "Put code owner definitions in the file" should specify "this file" or "here" for clarity. Consider: "Put code owner definitions here."
| # Put code owner definitions in the file. | |
| # Put code owner definitions here. |
No description provided.