Add contributor and maintainer guides #239
Merged
Conversation
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
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive documentation for contributors and maintainers by introducing a "Community" section to the documentation site. The documentation covers environment setup, development workflows, release procedures, and CI/CD interactions.
- Adds Contributing Guide covering environment setup, pre-commit hooks, branching workflows, and pull request guidelines
- Adds Maintainer Guide documenting release processes, CI label usage, and backporting procedures
- Updates README.md to reference the new Contributing Guide
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| mkdocs.yml | Adds Community navigation section with Contributing Guide and Maintainer Guide links |
| docs/community/contributing.md | New contributor documentation detailing environment setup, development workflow, and PR submission process |
| docs/community/maintainers.md | New maintainer documentation covering release workflow, CI labels, and backport procedures |
| README.md | Updates contributing section to reference the new Contributing Guide documentation |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
docs/community/maintainers.md
Outdated
| 4. **Update release collateral** | ||
| - Ensure the examples catalog at `examples/README.md` accurately reflects maintenance status and CI badges. | ||
| - Review the API reference pages in `docs/reference/` for outdated signatures or docstrings. | ||
| - Draft release notes in `docs/releases/` (create a new file for the version if necessary) and summarize key changes. Copy the same content into the GitHub release body later. |
There was a problem hiding this comment.
The docs/releases/ directory does not exist in the repository. This instruction should either be updated to reflect the actual location for release notes or the directory should be created as part of this PR.
Suggested change
| - Draft release notes in `docs/releases/` (create a new file for the version if necessary) and summarize key changes. Copy the same content into the GitHub release body later. | |
| - Draft release notes in `docs/releases/` (create the directory and a new file for the version if necessary) and summarize key changes. Copy the same content into the GitHub release body later. |
…x/add-contribution-and-maintainer-guides
totoluo
pushed a commit
to totoluo/agent-lightning
that referenced
this pull request
Nov 14, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
Testing
uv run mkdocs build --strict(fails locally: git metadata plugins warn about newly added pages; succeeds once merged)https://chatgpt.com/codex/tasks/task_e_69008739d37c832eb4faaec6e0092b8b