docs: add README, CONTRIBUTING guide, and project icon#3
Merged
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
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.
Summary
This PR introduces the complete public-facing documentation for the Runtime Node project. It adds the main
README.mdcovering what the image is, why it exists, a feature comparison table againstnode:latestandnode:alpine, quick start instructions, usage guidance with a sample multi-stageDockerfile, registry and platform information, CI/CD quality guarantees, versioning policy, and an acknowledgements section. It also addsCONTRIBUTING.mdcovering the full contributor workflow — branching strategy, branch naming conventions, Conventional Commits usage, PR structure requirements, the CI pipeline, the distroless guarantee, the release process, and Dockerfile constraints.Additionally, the project's SVG icon is introduced under
.github/assets/and is referenced in both documents.Files Changed
Added:
.github/assets/icon.svgCONTRIBUTING.mdREADME.mdModified:
Deleted:
Key Changes
README.mdwith a full project overview, a "What Is Runtime Node?" and "Why Runtime Node?" narrative, a key features table, a side-by-side comparison table againstnode:latestandnode:alpineacross size, shell, package manager, vulnerabilities, attack surface,NODE_ENVpreset, distroless status, multi-arch support, and provenance/SBOM.node --versionsmoke test commands for both Docker Hub and GHCR registries.Dockerfileshowing how to use Runtime Node as a base image, including a note on exec-formENTRYPOINTrequirements due to the absence of a shell.SemVer-NodeVersiontag format and immutability guarantee.CONTRIBUTING.mdwith a full contributor guide covering: branch strategy (main,develop,<type>/<short-description>), branch naming conventions, Conventional Commits format and allowed types with examples, PR title and description structure requirements, CI pipeline documentation (Hadolint lint job + multi-platform build and test matrix job with all four integrity tests), the distroless guarantee manifest listing every permitted image component and its path and purpose, the release process triggered byv*tags, and Dockerfile constraints that must be respected at all times..github/assets/icon.svg— the project's SVG icon featuring a metallic hexagon and radial green energy gradient, referenced in bothREADME.mdandCONTRIBUTING.md.