# Contributing to Zoi
First of all, thank you for considering contributing to Zoi! We're excited to have you on board and appreciate your help in making our project better. Every contribution, no matter how small, is valuable to us.
## How to Contribute
We welcome contributions in many forms, including bug reports, feature requests, documentation improvements, and code contributions.
### Reporting Bugs or Requesting Features
If you find a bug or have an idea for a new feature, please check our [**issue tracker**](https://gitlab.com/Zillowe/Zillwen/Zusty/Zoi/-/issues) to see if it has already been reported. If not, feel free to open a new issue.
- [Report a Bug](https://gitlab.com/Zillowe/Zillwen/Zusty/Zoi/-/issues/new?issuable_template=Bug%20Report)
- [Request a Feature](https://gitlab.com/Zillowe/Zillwen/Zusty/Zoi/-/issues/new?issuable_template=Feature%20Request)
### Contributing Code
If you'd like to contribute code, please follow these steps:
1. **Fork the repository** on [GitLab](https://gitlab.com/Zillowe/Zillwen/Zusty/Zoi).
2. **Clone your fork** to your local machine.
3. **Create a new branch** for your changes.
```sh
git checkout -b my-feature-branch
```
4. **Make your changes** and commit them with a clear and descriptive message.
5. **Push your changes** to your fork.
6. **Open a merge request** to the `main` branch of the original repository.
## Development Setup
To get started with developing Zoi, you'll need to set up your local environment.
### Prerequisites
- **Rust:** Make sure you have the latest version of Rust and Cargo installed. You can find instructions at [rust-lang.org](https://www.rust-lang.org/tools/install).
- **Make:** The `make` command is required for our Makefile-based build process.
### Building from Source
We recommend using `make` to build the project, as it simplifies the process.
1. **Configure the build:**
```sh
./configure
```
2. **Build and install:**
```sh
make
sudo make install
```
3. **Install shell completions (optional):**
```sh
make install-completions
```
If you don't have `make`, you can use the provided build scripts in the `./build` directory.
## Commit Messages
Please write clear and descriptive commit messages. A good commit message should explain the "what" and "why" of your changes.
## Code of Conduct
By contributing to Zoi, you agree to abide by our [Code of Conduct](./CODE_OF_CONDUCT.md). Please read it to understand our community standards.
Thank you again for your interest in contributing to Zoi! We look forward to your contributions.