Contributing to Matcha
First off, thank you for considering contributing to Matcha! It's people like you that make this project great.
How Can I Contribute?
Reporting Bugs
If you find a bug, please open an issue on our GitHub issues page. Please include as much detail as possible, including:
- A clear and descriptive title.
- Steps to reproduce the bug.
- What you expected to happen.
- What actually happened.
- Your operating system and terminal.
Suggesting Enhancements
If you have an idea for a new feature or an improvement to an existing one, please open an issue on our GitHub issues page. Please provide a clear description of the enhancement and why you think it would be a good addition.
Pull Requests
We love pull requests! If you're ready to contribute code, here's how to get started:
- Fork the repository.
- Create a new branch for your feature or bug fix:
git checkout -b feature/your-feature-nameorgit checkout -b fix/your-bug-fix. - Make your changes.
- Ensure your code is formatted with
go fmt ./.... - Run tests with
go test ./.... - Commit your changes with a descriptive commit message.
- Push your branch to your fork.
- Open a pull request to the
masterbranch of the main repository.
Development Setup
To get started with development, you'll need to have Go installed.
- Clone the repository:
git clone https://github.com/floatpane/matcha.git cd matcha - Install dependencies:
go mod tidy - Build the project:
go build -o matcha - Run the application:
./matcha
Code of Conduct
Please 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.