docs: Simplify README for CNCF project conventions - #163
Open
ipsitapp8 wants to merge 1 commit into
Open
Conversation
Remove decorative emoji, duplicate contributing instructions, and redundant sections to align with README patterns used by comparable CNCF graduated projects (Kubernetes, Prometheus, Envoy). Changes: - Add quick start with prerequisites and installation steps - Explain submodule requirement (theme not in npm) - Add note about running npm test before committing - Add development commands table - Add project structure overview - Add community links and license information - Add "good first contributions" pointer in Contributing - Remove emoji clutter (keep CNCF badge only) - Defer contributing workflow to CONTRIBUTING.md - Remove redundant "Built With" section - Fix double blank lines between sections - Simplify to scannable, essential information only No functional changes. All content and links preserved. Professional tone appropriate for security-critical software.
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
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.
Summary
Removes decorative emoji, duplicate contributing instructions, and redundant
walkthrough sections to align with README conventions used by comparable CNCF
graduated projects. Contributing detail is deferred entirely to CONTRIBUTING.md
and the org-wide community repo, avoiding two sources of truth for the
contribution workflow.
No functional changes — content and links preserved, structure condensed
for scannability.
Changes
No functional changes. All content and links preserved.
Professional tone appropriate for security-critical software.
Testing
Discussed with @JustinCappos on CNCF Slack #tuf channel.
This is my first contribution to TUF. Feedback very welcome!