# Contributing to Verid
First of all, thank you for your interest in contributing to Verid ❤️
Your help is very appreciated.
Verid is an open-source CLI tool focused on formatting and auditing code in a clean, fast, and reliable way.
---
## Ways to Contribute
There are many ways you can contribute:
- 🐛 Reporting bugs
- 💡 Suggesting new features
- 🛠 Improving code
- 📝 Improving documentation
- 🧪 Adding or improving tests
- ⚡ Improving performance
All contributions are welcome.
---
## Getting Started
1. Fork the repository
2. Clone your fork
```bash
git clone https://github.com/YOUR-USERNAME/verid.git
cd verid
```
3. Create a new branch
```bash
git checkout -b feature/my-feature
```
4. Build the project
```bash
cargo build
```
5. Run tests
```bash
cargo test
```
---
## Development Guidlines
Please make sure your changes follow the rules:
## Code Quality
- Code must compile without warnings
```bash
cargo clippy -- -D warnings
```
- Code must be formatted
```bash
cargo format
```
- All test must pass
```bash
cargo test
```
---
## Style
- Follow idiomatic Rust prastices
- Keep code simple and readable
- Prefer small, focused functions
- Avoid unnecessary dependecies
---
## Commit Messages
Use clear and descriptive commit messages.
Examples:
```
feat: add width formatter
fix: correct indentation edge case
docs: improve README clarity
test: add runner stability tests
```
---
## Pull Requests
When submitting a Pull Request:
- Explain **what** you changed and **why**
- Reference related issues (if any)
- Make sure CI passes
- Keep PRs focused and small
---
## Reporting issues
When oppening an issues, please include:
- Description of the problem
- Steps to reproduce
- Expected behavior
- Actual behavior
- Environment (OS, Rust version, etc.)
---
## Code of Conduct
Be respectful and kind to others.
We aim to build a welcoming and friendly community.
---
## Questions
If you have questions, feel free to open a discussion or issue.
---
Thank you for contributing to Verid 🚀