1# Contributing to Matcha
 2
 3First off, thank you for considering contributing to Matcha! It's people like you that make this project great.
 4
 5## How Can I Contribute?
 6
 7### Reporting Bugs
 8
 9If you find a bug, please open an issue on our [GitHub issues page](https://github.com/floatpane/matcha/issues). Please include as much detail as possible, including:
10
11- A clear and descriptive title.
12- Steps to reproduce the bug.
13- What you expected to happen.
14- What actually happened.
15- Your operating system and terminal.
16
17### Suggesting Enhancements
18
19If you have an idea for a new feature or an improvement to an existing one, please open an issue on our [GitHub issues page](https://github.com/floatpane/matcha/issues). Please provide a clear description of the enhancement and why you think it would be a good addition.
20
21### Pull Requests
22
23We love pull requests! If you're ready to contribute code, here's how to get started:
24
251.  Fork the repository.
262.  Create a new branch for your feature or bug fix: `git checkout -b feature/your-feature-name` or `git checkout -b fix/your-bug-fix`.
273.  Make your changes.
284.  Ensure your code is formatted with `go fmt ./...`.
295.  Run tests with `go test ./...`.
306.  Commit your changes with a descriptive commit message.
317.  Push your branch to your fork.
328.  Open a pull request to the `master` branch of the main repository.
33
34## Development Setup
35
36To get started with development, you'll need to have Go installed.
37
381.  Clone the repository:
39    ```bash
40    git clone https://github.com/floatpane/matcha.git
41    cd matcha
42    ```
432.  Install dependencies:
44    ```bash
45    go mod tidy
46    ```
473.  Build the project:
48    ```bash
49    go build -trimpath -ldflags="-s -w" -o matcha
50    ```
514.  Run the application:
52    ```bash
53    ./matcha
54    ```
55
56## Code of Conduct
57
58Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. Please read the [Code of Conduct](CODE_OF_CONDUCT.md).