Skip to content

docs: enhance README with badges and protocol counts, add CONTRIBUTING.md, PR template, and LICENSE#15

Open
YutaSugimura wants to merge 1 commit intomainfrom
docs/enhance-readme-and-contributing
Open

docs: enhance README with badges and protocol counts, add CONTRIBUTING.md, PR template, and LICENSE#15
YutaSugimura wants to merge 1 commit intomainfrom
docs/enhance-readme-and-contributing

Conversation

@YutaSugimura
Copy link
Owner

Summary

  • README.md: Rewrite with Shields.io badges (Stars, Forks, Last Commit, License, Link Check), table of contents, protocol counts per chain, and new Contributing/Smart Contract Addresses sections
  • CONTRIBUTING.md: New file with inclusion criteria, entry format guide, and PR guidelines
  • PR Template: New .github/pull_request_template.md with checklist for contributors
  • LICENSE: CC0-1.0 full text for GitHub auto-recognition

Test plan

  • Verify README table of contents links navigate correctly
  • Confirm Shields.io badges render properly on GitHub
  • Check markdown-link-check-disable/enable comments are preserved for CI compatibility
  • Verify GitHub recognizes the LICENSE file as CC0-1.0
  • Confirm PR template appears when creating new PRs

🤖 Generated with Claude Code

…G.md, PR template, and LICENSE

- Rewrite README.md with Shields.io badges, table of contents, protocol counts per chain, and contributing/address sections
- Add CONTRIBUTING.md with inclusion criteria, entry format, and PR guidelines
- Add .github/pull_request_template.md with checklist
- Add CC0-1.0 LICENSE file for GitHub recognition

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
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.

1 participant