Revise CONTRIBUTING.md for NeuVector Docs#257
Open
allexistence wants to merge 2 commits into
Open
Conversation
Clarified instructions for editing documentation files and added notes about versioned documentation.
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
2 participants
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
Fix #256
Replaces CONTRIBUTING.md, which is leftover boilerplate from the Grav project (references getgrav/grav, Gitter, Grav-specific requirements) and doesn't apply to this repo. New content covers actual setup (
yarn install,yarn start), how to make a change, and how to report issues, based on what's in README.md.This is a starting draft to replace outdated content that referenced an unrelated project — happy to adjust based on the maintainer's actual preferred process (e.g. CLA, review expectations) if different from what's proposed here.
Test
Docs-only change.
Additional Information
Tradeoff
Kept this factual and minimal, happy to expand if there's an existing process I should reflect.
Potential improvement
Could add a PR template or issue template once contribution volume picks up.