Skip to content

Latest commit

 

History

History
80 lines (50 loc) · 2.31 KB

CONTRIBUTING.md

File metadata and controls

80 lines (50 loc) · 2.31 KB

Contributing to Walrus

Thank you for your interest in contributing to Walrus! We welcome contributions from the community and appreciate your help in making this project better.

Getting Started

  1. Fork the repository
  2. Clone your fork locally
  3. Create a new branch for your changes
  4. Make your changes
  5. Test your changes thoroughly
  6. Submit a pull request

Requirements

Testing

All changes must pass the existing test suite. Before submitting your pull request:

  1. Run the full test suite

  2. Ensure all tests pass without any failures or warnings

  3. If you're adding new functionality, please include appropriate tests

  4. For performance-critical changes, consider running the benchmarks

Code Quality

  • Write clear, self-documenting code with appropriate comments
  • Follow existing code patterns and conventions in the project

Types of Contributions

We welcome various types of contributions:

  • Bug fixes: Help us identify and fix issues
  • Feature additions: Propose and implement new functionality
  • Performance improvements: Optimize existing code
  • Documentation: Improve code comments, README, or other documentation
  • Tests: Add test coverage for existing functionality
  • Bug reports: Report issues you encounter
  • Feature requests: Suggest new features or improvements

Submitting Issues

When submitting issues, please:

  • Use a clear and descriptive title
  • Provide detailed steps to reproduce the issue
  • Include relevant system information (OS, Rust version, etc.)
  • Add any relevant error messages or logs
  • Check if the issue already exists before creating a new one

Pull Request Process

  1. Ensure your code follows the requirements above
  2. Update documentation if your changes affect the public API
  3. Add or update tests as necessary
  4. Ensure the PR description clearly describes the problem and solution
  5. Link any relevant issues in your PR description

Questions and Support

If you have questions about contributing or need help getting started:

  • Open an issue with the "question" label
  • Check existing issues and discussions
  • Review the project's README for additional context

Code of Conduct

Please be respectful and constructive in all interactions. We're here to build something great together!

Thank you for contributing to Walrus! 🦭