Tree-ds
=======
We appreciate your interest in contributing to `tree-ds`! This document outlines the process for submitting pull requests and other contributions.
### Getting Started
- Fork the repository: Create a fork of the `tree-ds` repository on GitHub. This will allow you to make changes and submit pull requests.
- Set up your development environment: Ensure you have Rust and Cargo installed. Refer to the official Rust documentation for installation instructions: https://www.rust-lang.org/tools/install
- Clone your fork: Clone your forked repository to your local machine.
### Making Changes
- Identify an issue: Check the issue tracker for existing issues or feature requests. If you can't find one that matches your contribution, feel free to create a new issue.
- Create a branch: Create a new branch for your specific contribution. Use a descriptive branch name that reflects the changes you're making.
- Make your changes: Implement your changes in the codebase. Follow the existing code style and formatting conventions.
- Write unit tests: Ensure your changes are covered by unit tests. We recommend using the cargo test command to run tests.
- Document your changes: Update the documentation (README.md) to reflect any new features or functionalities introduced by your contribution.
### Submitting Pull Requests
- Push your changes: Push your branch to your forked repository on GitHub.
- Open a pull request: Create a pull request from your branch to the main branch of the upstream repository.
- Describe your changes: Provide a clear and concise description of your changes in the pull request description. This should include what problem your contribution solves, any relevant code examples, and potential breaking changes (if applicable).
- Respond to feedback: We will review your pull request and provide feedback. Be prepared to address any comments or questions raised during the review process.
### Additional Guidelines
- Follow the code style: Adhere to the existing code style and formatting conventions used in the project. This helps maintain consistency and readability of the codebase.
- Write clear and concise code: Strive to write clean, readable, and well-commented code.
- Test your changes: Ensure your changes are thoroughly tested with unit tests and regression tests.
- Respectful communication: Maintain a respectful and professional tone in all interactions.
Thank you!
We appreciate your contributions to `tree-ds`. Your help makes this project better for everyone!