Docs: Move contributing guide to root and update developer documentation#792
Open
HARSHVARANDANI wants to merge 3 commits into
Open
Docs: Move contributing guide to root and update developer documentation#792HARSHVARANDANI wants to merge 3 commits into
HARSHVARANDANI wants to merge 3 commits into
Conversation
Signed-off-by: HARSHVARANDANI <hpvarandani@gmail.com>
Signed-off-by: HARSHVARANDANI <hpvarandani@gmail.com>
Signed-off-by: HARSHVARANDANI <hpvarandani@gmail.com>
✅ Deploy Preview for urunc ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
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 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.
Description
This PR makes the root
CONTRIBUTING.mdthe single source of truth for the project's contribution guidelines.Previously, the root
CONTRIBUTING.mdonly redirected contributors todocs/developer-guide/contribute.md. Since GitHub automatically surfaces the rootCONTRIBUTING.mdwhen users open issues and pull requests, contributors would not immediately see the project's contribution guidelines.This change:
CONTRIBUTING.md.CONTRIBUTING.mdin the Developer Guide usingpymdownx.snippets, eliminating duplicate documentation.pymdownx.snippetsbase_pathso the root file can be referenced from the documentation.This ensures contributors receive the full guidelines directly on GitHub while maintaining only a single copy of the documentation.
Related issues
How was this tested?
Verified that the documentation site builds successfully with:
Confirmed that the Developer Guide renders the contents of the root
CONTRIBUTING.md.LLM usage
N/A
Checklist
make lint).make test_ctr,make test_nerdctl,make test_docker,make test_crictl).