diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..263bdc1 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,51 @@ +# Contributing to Hopp 🧑‍💻 + +Thank you for your interest in contributing to **Hopp**, the open source pair programming app! We love collaboration and welcome contributions of all sizes—from reporting bugs to adding new features or improving documentation. + +By contributing, you help make Hopp better for everyone. + +--- + +## Table of Contents +1. [How to Contribute](#how-to-contribute) +2. [Reporting Issues](#reporting-issues) +3. [Development Setup](#development-setup) +4. [Submitting Pull Requests](#submitting-pull-requests) +5. [Code of Conduct](#code-of-conduct) +6. [Community](#community) + +--- + +## How to Contribute + +There are many ways to contribute: + +- **Bug Reports** – Help us identify and fix bugs. +- **Feature Requests** – Suggest new features or improvements. +- **Code Contributions** – Fix bugs, improve performance, or add new features. +- **Documentation** – Improve guides, README, or tutorials. +- **Feedback & Testing** – Try out new features and give feedback. + +--- + +## Reporting Issues + +If you find a bug or have a feature suggestion: + +1. Check our [issues page](https://github.com/gethopp/hopp/issues) to see if it already exists. +2. If not, create a **new issue** with: + - A clear and descriptive title + - Steps to reproduce (for bugs) + - Screenshots or logs if applicable + - Expected vs. actual behavior + +--- + +## Development Setup + +To contribute code, you need to set up Hopp locally. + +### 1. Clone the repository +```bash +git clone https://github.com/gethopp/hopp.git +cd hopp