|
1 | | -123 |
| 1 | +# Contributing Guide |
| 2 | + |
| 3 | +Welcome! |
| 4 | +Thank you for your interest in improving **python-boilerplate/poetry-template**. This project is my personal template, and **only bug fixes are accepted**. |
| 5 | + |
| 6 | +--- |
| 7 | + |
| 8 | +## 🐞 Reporting a Bug |
| 9 | + |
| 10 | +Before submitting a bug report: |
| 11 | + |
| 12 | +- **Check** that the issue hasn’t already been reported in the [Issues](https://github.com/python-boilerplate/poetry-template/issues) section. |
| 13 | + |
| 14 | +When reporting a bug, please include: |
| 15 | + |
| 16 | +- **Steps to reproduce** the bug |
| 17 | +- **Expected** vs **actual** behavior |
| 18 | +- Any **logs, error traces, or screenshots** (if applicable) |
| 19 | +- Details about your **Python version**, **OS**, and any relevant environment info |
| 20 | + |
| 21 | +> Clear, detailed bug reports or feature descriptions help address problems faster. |
| 22 | +
|
| 23 | +--- |
| 24 | + |
| 25 | +## 🔄 How to Contribute (Pull Request) |
| 26 | + |
| 27 | +1. **Fork** this repository to your own GitHub account. |
| 28 | +2. **Create a branch** for your fix. |
| 29 | + _Branch naming suggestion:_ `fix/short-bug-description` |
| 30 | +3. **Apply your changes** on that branch (**_if it's a bug_**). |
| 31 | +4. **Test your code**: |
| 32 | + - Run the test suite: |
| 33 | + ```bash |
| 34 | + make test |
| 35 | + ``` |
| 36 | + - Run the linter: |
| 37 | + ```bash |
| 38 | + make lint && make format |
| 39 | + ``` |
| 40 | +5. **Describe your PR** clearly and informatively. |
| 41 | +6. **Open a Pull Request** from your branch to this repository. |
| 42 | + |
| 43 | +--- |
| 44 | + |
| 45 | +## ✅ Code Requirements |
| 46 | + |
| 47 | +!!! success "!" |
| 48 | + |
| 49 | + - **Follow the existing code style.** |
| 50 | + - **Make sure all tests pass** (`pytest`) (if needed). |
| 51 | + - **Lint and Format your code** with `ruff` before submitting (if needed). |
| 52 | + - **Do not** add new features or change existing functionality without agreement. |
| 53 | + |
| 54 | +--- |
| 55 | + |
| 56 | +## ❓ Questions |
| 57 | + |
| 58 | +!!! question "!" |
| 59 | + |
| 60 | + If you have questions about contributing, |
| 61 | + please [open an issue](https://github.com/python-boilerplate/poetry-template/issues/new) or comment on an existing one. |
| 62 | + |
| 63 | +--- |
| 64 | + |
| 65 | +Thank you for helping make this template better! |
0 commit comments