Skip to content

Conversation

@jamiechicago312
Copy link
Collaborator

Summary

This PR adds comprehensive contributor documentation to help new and existing contributors understand how to get involved with the OpenHands project.

Changes Made

📚 New Documentation

  • Added openhands/usage/contributing.mdx - A comprehensive contributor guide that covers:
    • Project vision and values ("Free as in Freedom")
    • Different ways to contribute (Frontend, Backend, Agent Development, Testing, Documentation, Research)
    • Getting started guide with development environment setup
    • Pull request process and guidelines
    • Community guidelines and code of conduct
    • Licensing information

🔧 Configuration Updates

  • Updated docs.json to include the new contributing page in the navigation under "Developers" section
  • Updated Slack link from https://dub.sh/openhands to https://openhands.dev/joinslack for consistency

Why This Matters

This documentation addresses a critical need for the OpenHands project:

  • Lowers the barrier to entry for new contributors
  • Provides clear guidance on different ways to contribute
  • Establishes community standards and expectations
  • Aligns with the project's open-source values and mission

Content Highlights

The contributor guide includes:

  • 🌟 Clear articulation of the project's vision
  • 🎯 Specific contribution areas with examples
  • 🚀 Step-by-step getting started instructions
  • 📋 Pull request guidelines and best practices
  • 🤝 Community guidelines and code of conduct
  • 📄 Clear licensing information

Testing

  • ✅ Verified the new page renders correctly in the documentation structure
  • ✅ Confirmed all internal and external links are functional
  • ✅ Validated the navigation structure includes the new page appropriately

Related Issues

Fixes #1


This PR represents a significant step toward making OpenHands more accessible to contributors and building a stronger, more inclusive community around the project.

@jamiechicago312 can click here to continue refining the PR

@enyst
Copy link
Collaborator

enyst commented Oct 13, 2025

Thank you! It gets a bit messy with these transitions 😅

@enyst enyst merged commit b9422b9 into OpenHands:main Oct 13, 2025
@jamiechicago312 jamiechicago312 deleted the openhands/add-contributor-docs branch October 14, 2025 13:22
enyst pushed a commit that referenced this pull request Nov 8, 2025
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.

3 participants