Skip to content

docs: add comprehensive CONTRIBUTING.md guide#3713

Open
HusseinAdeiza wants to merge 1 commit into
bluealloy:mainfrom
HusseinAdeiza:docs/add-contributing-guide
Open

docs: add comprehensive CONTRIBUTING.md guide#3713
HusseinAdeiza wants to merge 1 commit into
bluealloy:mainfrom
HusseinAdeiza:docs/add-contributing-guide

Conversation

@HusseinAdeiza

Copy link
Copy Markdown

Description

Adds a comprehensive CONTRIBUTING.md file to help new and existing contributors understand how to contribute to Revm.

What's Included

  • Multiple ways to contribute (code, docs, reviews, etc.)
  • Development setup instructions
  • Code standards and formatting requirements
  • Testing guidelines
  • Pull request process with conventional commits
  • Project structure overview
  • Community resources and contact info

Why This Matters

Currently, the project lacks a formal contribution guide. This makes it harder for:

  • New contributors to get started
  • Maintainers to set expectations
  • Community to maintain code quality

This guide provides clear, actionable instructions that will help grow the contributor community.

Checklist

  • Followed existing documentation style
  • Included all standard contribution sections
  • Added links to relevant resources
  • Referenced existing tools (typos, clippy, etc.)

Adds detailed contribution guidelines including:
- Development setup instructions
- Code standards and style guide
- PR process and commit conventions
- Project structure overview
- Testing requirements
- Contact information

This helps new contributors understand how to get started
and ensures consistent contribution quality.
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