made changes in files #20656
Open
made changes in files #20656
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
✅ Deploy Preview for cockroachdb-api-docs canceled.
|
✅ Deploy Preview for cockroachdb-docs canceled.Built without sensitive environment variables
|
✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
I updated README.md. Summary of changes (concise):
Added "Contents summary" — outlines typical repo directories and purpose.
Added "Getting started (clone)" — HTTPS and SSH git clone commands.
Added "Raise a Pull Request (typical workflow)" — step-by-step branch, commit, push, PR guidance and PR description checklist.
Added "Local preview and testing" — instructions to check CONTRIBUTING.md and example commands for running a local preview.
Expanded "Contributing & support" — brief contribution guidelines.
Added "Useful links" — links to repo, live docs, issues, templates, discussions, and local paths.
Added "Development details (local setup)" — example local setup for Hugo, MkDocs, and Docker.
Added "Branch & commit conventions" — branch naming and commit message guidance (Conventional Commits example).
Added "CI, linters & checks" — note about CI pipelines and pre-PR checks.
Added "Reporting security issues" — guidance to avoid public issues and reference to GitHub security advisories.
Added "License" — pointer to the LICENSE file.