CONTRIBUTING.md (1843B)
1 # Contributing to Githrun 2 3 First off, thanks for taking the time to contribute! 4 5 The following is a set of guidelines for contributing to Githrun. These are just guidelines, not rules. Use your best judgment and feel free to propose changes to this document in a pull request. 6 7 ## How Can I Contribute? 8 9 ### Reporting Bugs 10 This section guides you through submitting a bug report for Githrun. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports. 11 12 - **Use a clear and descriptive title** for the issue to identify the problem. 13 - **Describe the exact steps which reproduce the problem** in as many details as possible. 14 - **Provide specific examples** to demonstrate the steps. 15 16 ### Pull Requests 17 18 1. **Fork the repository** on GitHub. 19 2. **Clone your fork** locally: 20 ```bash 21 git clone [https://github.com/your-username/githrun.git](https://github.com/your-username/githrun.git) 22 cd githrun 23 ``` 24 3. **Create a virtual environment** to keep dependencies isolated: 25 ```bash 26 python -m venv venv 27 source venv/bin/activate # On Windows use `venv\Scriptsctivate` 28 ``` 29 4. **Install dependencies** (we use Poetry/pip): 30 ```bash 31 pip install -r requirements.txt 32 ``` 33 5. **Create a new branch** for your feature or fix: 34 ```bash 35 git checkout -b feature/amazing-feature 36 ``` 37 6. **Commit your changes** with clear messages: 38 ```bash 39 git commit -m "Add some amazing feature" 40 ``` 41 7. **Push to the branch**: 42 ```bash 43 git push origin feature/amazing-feature 44 ``` 45 8. **Open a Pull Request** on the main Githrun repository. 46 47 ## Style Guide 48 - We follow **PEP 8** standards. 49 - Please write clear comments for complex logic. 50 - If you add a new feature, please add a corresponding test case (if applicable).