shardeum icon indicating copy to clipboard operation
shardeum copied to clipboard

improved and comprehensive CONTRIBUTING.md

Open ajeebtech opened this issue 1 month ago • 0 comments

Summary

Significantly expanded the CONTRIBUTING.md file to provide comprehensive guidance for new and existing contributors.

Changes Made

  • Added detailed Getting Started section with prerequisites and environment setup
  • Created How to Contribute section covering bug reports, enhancements, and first contributions
  • Expanded Coding Standards with TypeScript guidelines, formatting rules, and linting requirements
  • Added comprehensive Testing Requirements section with examples and coverage expectations
  • Included Commit Guidelines with Conventional Commits format and examples
  • Added Documentation and Security sections
  • Enhanced Community section with links to Discord, GitHub Discussions, and Twitter
  • Improved existing sections (Branch Organization, Pull Request Process) with clearer formatting and examples
  • Fixed typo in title ("Contrubution" → "Contributing")

Motivation

The previous CONTRIBUTING.md was sparse (58 lines) and lacked important information that would help new contributors get started. This update provides:

  • Clear onboarding steps for new contributors
  • Detailed coding standards matching our ESLint and Prettier configs
  • Testing requirements and examples
  • Better organization with table of contents
  • Security and community guidelines

File Changes

  • Modified: CONTRIBUTING.md (58 lines → 455 lines)

Checklist

  • [x] Follows existing documentation style
  • [x] Includes accurate technical information (versions, commands, configs)
  • [x] Links to existing resources (README.md, CODE_OF_CONDUCT.md, SECURITY.md)
  • [x] Provides actionable guidance for contributors
  • [x] No code changes required

ajeebtech avatar Nov 24 '25 10:11 ajeebtech