Description
The current root CONTRIBUTING.md is a one-liner that simply redirects to docs/developer-guide/contribute.md. Since GitHub automatically surfaces CONTRIBUTING.md when users open issues and PRs, this is a missed opportunity to provide quick, essential contributing information (Go version, commit format, DCO sign-off, basic make targets) right where contributors need it.
The proposal is to move the full contributing content into the root CONTRIBUTING.md and configure mkdocs to reference it directly (using the snippets or include plugin), so we maintain only one file and the docs site stays updated automatically without manual syncing.
This was discussed on the #urunc Slack channel and the approach was acknowledged as a good idea.
System Info
- Urunc version: v0.7.0
- Arch: N/A (documentation change)
- VMM: N/A
- Unikernel: N/A
Description
The current root CONTRIBUTING.md is a one-liner that simply redirects to docs/developer-guide/contribute.md. Since GitHub automatically surfaces CONTRIBUTING.md when users open issues and PRs, this is a missed opportunity to provide quick, essential contributing information (Go version, commit format, DCO sign-off, basic make targets) right where contributors need it.
The proposal is to move the full contributing content into the root CONTRIBUTING.md and configure mkdocs to reference it directly (using the snippets or include plugin), so we maintain only one file and the docs site stays updated automatically without manual syncing.
This was discussed on the #urunc Slack channel and the approach was acknowledged as a good idea.
System Info