Skip to content

docs: add CONTRIBUTING.md link to README#178

Merged
MegaRedHand merged 1 commit intomainfrom
add-contributing-link-readme-5d4e63
Mar 2, 2026
Merged

docs: add CONTRIBUTING.md link to README#178
MegaRedHand merged 1 commit intomainfrom
add-contributing-link-readme-5d4e63

Conversation

@MegaRedHand
Copy link
Copy Markdown
Collaborator

Summary

  • Adds a "Contributing" section to README.md that links to CONTRIBUTING.md
  • Improves discoverability of contribution guidelines for new contributors

Changes

README.md

  • Inserted a new "Contributing" section between the "Getting started" and "Philosophy" sections
  • Section contains a direct link to CONTRIBUTING.md for easy navigation

Test plan

  • Open README.md and verify the "Contributing" section appears between "Getting started" and "Philosophy"
  • Confirm the link to CONTRIBUTING.md renders correctly and points to the right file
  • If viewing on GitHub, click the link to ensure it resolves without a 404

Created via Tekton Dashboard

@github-actions
Copy link
Copy Markdown

github-actions bot commented Mar 2, 2026

🤖 Kimi Code Review

Review Summary

The changes in this PR are minimal and only affect documentation. The README.md addition is appropriate and follows standard open-source practices.

Specific Feedback

README.md

  • Line 47-49: The contribution link is correctly formatted and points to an existing CONTRIBUTING.md file. No issues found.

Security Assessment

No security concerns - this is purely documentation.

Performance Impact

No performance impact - documentation only.

Rust Best Practices

Not applicable - no Rust code changes.

Consensus-Layer Considerations

Not applicable - no consensus code changes.

Verdict: ✅ LGTM - Simple documentation improvement with no issues.


Automated review by Kimi (Moonshot AI) · custom prompt

@github-actions
Copy link
Copy Markdown

github-actions bot commented Mar 2, 2026

🤖 Codex Code Review

No findings.

  • Change is documentation-only in README.md, adding a Contributing section with a link to CONTRIBUTING.md.
  • I verified the target file exists at CONTRIBUTING.md.
  • No consensus/fork-choice/attestation/state-transition/XMSS/SSZ code paths are modified, so there is no direct correctness, security, or performance impact from this PR.

Automated review by OpenAI Codex · custom prompt

@github-actions
Copy link
Copy Markdown

github-actions bot commented Mar 2, 2026

🤖 Claude Code Review

This is a purely documentation change — a 4-line addition to README.md adding a "Contributing" section.


Review: PR 178 — Add Contributing Link README

Scope: Documentation only. No Rust code, no logic, no tests affected.

What Changed

A new ## Contributing section is inserted between ## Getting started and ## Philosophy in README.md, pointing to CONTRIBUTING.md.

Assessment

The change is correct and appropriate:

  • The placement (after Getting Started, before Philosophy) is a natural location for contribution guidelines.
  • The relative link ./CONTRIBUTING.md is the correct format for GitHub Markdown and will resolve properly.
  • The wording is clear and welcoming.
  • The section heading is consistent with the document's existing ## heading level.

Minor Nit

The link text "CONTRIBUTING.md" could alternatively read "contribution guidelines" or similar for a more natural prose flow, but the current form is also conventional and immediately legible — no change required.

No correctness, security, or Rust concerns. This is a clean, minimal, and well-placed documentation improvement.


Automated review by Claude (Anthropic) · custom prompt

@MegaRedHand MegaRedHand changed the title Add Contributing Link README docs: add CONTRIBUTING.md link to README Mar 2, 2026
@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps bot commented Mar 2, 2026

Greptile Summary

This PR adds a Contributing section to the README that links to the existing CONTRIBUTING.md file, improving discoverability for new contributors.

  • Added new Contributing section between Getting started and Philosophy sections
  • Includes welcoming message and direct link to contribution guidelines
  • Proper placement and formatting consistent with existing README structure

Confidence Score: 5/5

  • This PR is safe to merge with no risk
  • Simple documentation change that adds a Contributing section to README with a valid link to existing CONTRIBUTING.md file. No code logic changes, no security concerns, and the link has been verified to point to an existing file.
  • No files require special attention

Important Files Changed

Filename Overview
README.md Added Contributing section with link to CONTRIBUTING.md between Getting started and Philosophy sections

Last reviewed commit: d09cecf

@MegaRedHand MegaRedHand merged commit 145f9d5 into main Mar 2, 2026
7 checks passed
@MegaRedHand MegaRedHand deleted the add-contributing-link-readme-5d4e63 branch March 2, 2026 21:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants