Skip to main content

Contributing

We welcome contributions to BakinBytes projects! This guide will help you get started.

Code Style​

We maintain high standards for code quality and performance:

Rust Projects​

  • Use cargo fmt for formatting
  • Run cargo clippy for linting
  • Ensure all tests pass with cargo test
  • Follow Rust naming conventions and idiomatic patterns

TypeScript/JavaScript Projects​

  • Use consistent formatting (Prettier configuration where available)
  • Follow TypeScript strict mode
  • Write comprehensive tests

General Principles​

  • Performance First: Always consider performance implications
  • No Bloat: Avoid unnecessary dependencies or abstractions
  • Clear Documentation: Document public APIs and complex logic
  • Test Coverage: Maintain good test coverage for critical paths

Submitting Changes​

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes following our style guidelines
  4. Add or update tests as needed
  5. Ensure all checks pass
  6. Submit a pull request with a clear description

Getting Help​

  • Check existing issues and discussions
  • Review project documentation
  • Feel free to ask questions in issues or discussions

Thank you for contributing to BakinBytes!