Contributing

The canonical contribution guide lives in the repository root CONTRIBUTING.md.

Use the top-level file for the current workflow, check commands, and contribution expectations.

  1. Documentation
    • Improve architecture docs
    • Add inline code comments
    • Create tutorials

Good First Issues

New to the project? Look for issues labeled:

  • good-first-issue: Perfect for beginners
  • help-wanted: Need community help
  • documentation: Doc improvements

Review Process

Reviewer Responsibilities

  • Check code quality and style
  • Verify tests are adequate
  • Look for performance issues
  • Suggest improvements

Author Responsibilities

  • Respond to feedback promptly
  • Make requested changes
  • Ask questions if unclear
  • Be open to criticism

Merge Criteria

PRs are merged when:

  • All tests pass
  • Code review is approved
  • Documentation is complete
  • No conflicts with main branch

Community Channels

Get Help

  • GitHub Issues: For bug reports and feature requests
  • GitHub Discussions: For questions and ideas
  • Discord: Join our community server (link in README)
  • Email: Direct contact with maintainers

Stay Updated

  • Watch the repository for updates
  • Follow releases on GitHub
  • Subscribe to changelog
  • Check out discussions

Licensing

By contributing, you agree that your contributions will be licensed under the project's license (see LICENSE file).

Questions?

Don't hesitate to ask! The best way to learn is by contributing.

  • Open a GitHub Discussion
  • Leave a comment on an issue
  • Reach out to maintainers directly

Thank you for being part of Void! 🎮