Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
102 lines (76 loc) · 2.86 KB

CONTRIBUTING.md

File metadata and controls

102 lines (76 loc) · 2.86 KB

Contributing to Nine Realities Netcode

First off, thank you for considering contributing to Nine Realities Netcode! It's people like you that make this research valuable to the game development community.

🎯 Ways to Contribute

  • Bug Reports: Found an error in our analysis? Open an issue!
  • Documentation: Improve explanations, fix typos, add examples
  • Code Examples: Share implementations in different languages
  • Research: Add case studies, benchmarks, or new insights
  • Feedback: Share your experience using this framework

📋 Guidelines

Code of Conduct

This project adheres to a simple code of conduct:

  • Be respectful and inclusive
  • Focus on constructive technical discussion
  • Help maintain a welcoming environment for all contributors
  • Harassment, trolling, or discriminatory behavior will not be tolerated

Pull Request Process

  1. Fork the repository and create your branch from main
  2. Make your changes following our standards:
    • Keep commits atomic and well-described
    • Add tests if contributing code examples
    • Update documentation as needed
  3. Test your changes thoroughly
  4. Submit a pull request with:
    • Clear description of what you changed and why
    • Reference any related issues
    • Screenshots/examples if applicable

Code Standards

For Code Examples:

  • Follow language-specific best practices
  • Include inline comments explaining netcode concepts
  • Add unit tests demonstrating correctness
  • Optimize for readability over cleverness

For Documentation:

  • Use clear, concise language
  • Include visual diagrams where helpful
  • Cite sources for technical claims
  • Follow existing formatting style

Commit Message Format

Use semantic commit messages:

feat: Add client-side prediction example in Rust
fix: Correct rollback calculation in JavaScript example
docs: Improve explanation of snapshot interpolation
test: Add benchmark for 100ms RTT scenario

🔬 Research Contributions

When contributing research or analysis:

  • Cite your sources
  • Provide evidence for claims
  • Explain methodology clearly
  • Acknowledge limitations

🛠 Development Setup

For Documentation

git clone https://github.com/POWDER-RANGER/nine-realities-netcode.git
cd nine-realities-netcode/docs
# Open index.html in your browser

For Code Examples

cd examples
# Follow language-specific setup in example README files

📞 Getting Help

  • Questions: Open a Discussion
  • Bugs: Open an Issue
  • Chat: Tag @POWDER-RANGER in discussions

📄 License

By contributing, you agree that your contributions will be licensed under the MIT License.

🙏 Recognition

All contributors will be:

  • Listed in our CONTRIBUTORS file
  • Credited in release notes
  • Mentioned in relevant documentation

Thank you for helping advance the understanding of multiplayer game networking! 🚀