Contributing

Thank you for your interest in contributing to the Rust Standard Library Showcase! 🦀

How to Contribute

Types of Contributions

• Bug Fixes: Found an error? Help us fix it!
• Documentation Improvements: Better explanations or examples
• New Features: Additional stdlib features to showcase
• Code Quality: Improved patterns or best practices

Getting Started

1. Fork the repository on GitHub
2. Clone your fork locally
3. Create a feature branch: git checkout -b my-feature
4. Make your changes
5. Test your changes: cargo build && cargo run
6. Commit with clear messages
7. Push to your fork
8. Open a Pull Request

Code Style

• Follow Rust conventions (use rustfmt)
• Add clear comments for complex logic
• Update documentation if needed
• Keep examples simple and educational

Documentation

This documentation is built with mdBook. To build locally:

cd docs
mdbook serve

Then open http://localhost:3000 in your browser.

Pull Request Guidelines

• Keep PRs focused on a single change
• Describe what and why in the PR description
• Be responsive to feedback
• Ensure all tests pass

Code of Conduct

This project follows the Rust Code of Conduct. Please be respectful and inclusive.

Questions?

• Open an issue for questions or discussions
• Check existing issues before creating new ones

Thank you for helping make Rust education better! 🚀