Skip to content

Commit e404ff7

Browse files
lexfreiclaude
andcommitted
docs(contributing): add reference to developer documentation
Follow-up to kubernetes-sigs#5889 discussion about documentation discoverability. Add a new "Developer Documentation" section in CONTRIBUTING.md that references the detailed developer guides in docs/contributing/. This improves discoverability for contributors and helps avoid split-brain when looking for development guidance. Co-Authored-By: Claude <[email protected]>
1 parent 994f4dc commit e404ff7

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

CONTRIBUTING.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,16 @@ We have full documentation on how to get started contributing here:
1212
- [Kubernetes Contributor Guide](https://git.k8s.io/community/contributors/guide) - Main contributor documentation, or you can just jump directly to the [contributing section](https://git.k8s.io/community/contributors/guide#contributing)
1313
- [Contributor Cheat Sheet](https://git.k8s.io/community/contributors/guide/contributor-cheatsheet) - Common resources for existing developers
1414

15+
## Developer Documentation
16+
17+
For more detailed contribution guides, see [Developer Documentation](docs/contributing) which includes:
18+
19+
- [Development Guide](docs/contributing/dev-guide.md) - Setting up development environment, building, and testing
20+
- [Chart Development](docs/contributing/chart.md) - Working with Helm charts
21+
- [Design Documentation](docs/contributing/design.md) - Architecture and design decisions
22+
- [Sources and Providers](docs/contributing/sources-and-providers.md) - Adding new sources and providers
23+
- [Source Wrappers](docs/contributing/source-wrappers.md) - Source wrapper implementation details
24+
1525
This project follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification on PR title. The explicit commit history is used, among other things, to provide a readable changelog in release notes.
1626

1727
## How to test a PR

0 commit comments

Comments
 (0)