# Contributing to BD18378
Thank you for your interest in contributing to the **BD18378 Rust Driver** project! We welcome contributions from everyone. This document will help you get started.
## 🧰 How to Contribute
### 1. Fork and Clone
First, [fork the repository](https://github.com/Uekue/bd18378-rs) and then clone it:
```bash
git clone https://github.com/Uekue/bd18378-rs.git
cd bd18378-rs
```
### 2. Create a Branch
Create a descriptive branch for your changes:
```bash
git checkout -b feature/your-feature-name
```
### 3. Make Your Changes
* Follow Rust best practices
* Use `cargo fmt` to format your code
* Run `cargo clippy` for linting
* Add or update tests if necessary
* Document public APIs using Rustdoc comments (`///`)
### 4. Run Tests
Before submitting a pull request, make sure everything works:
```bash
cargo test
```
## 📄 Commit Guidelines
Please write clear, concise commit messages. For example:
```
Add support for reading status registers
```
## 🚀 Submitting a Pull Request
1. Push your branch:
```bash
git push origin feature/your-feature-name
```
2. Open a Pull Request on GitHub against the `main` branch
3. Provide a description of the changes and any relevant issue numbers
## 🙌 Code of Conduct
This project adheres to the [Contributor Covenant Code of Conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct/). By participating, you are expected to uphold this code.
## ❓ Questions or Feedback
If you have questions, feel free to open an issue or start a discussion on the GitHub Discussions tab (if enabled).
Thank you for helping improve this project! 🚀