chore: added pr template and updated CONTRIBUTING
5bb6389e
2 file(s) · +26 −0
| 1 | + | ## Related Issue |
|
| 2 | + | ||
| 3 | + | <!-- Link the approved issue this PR addresses, e.g. "Closes #123" --> |
|
| 4 | + | <!-- PRs without a corresponding approved issue will be closed. --> |
|
| 5 | + | ||
| 6 | + | ## Description |
|
| 7 | + | ||
| 8 | + | <!-- Briefly describe what this PR does --> |
|
| 9 | + | ||
| 10 | + | ## Type of Change |
|
| 11 | + | ||
| 12 | + | - [ ] Bug fix |
|
| 13 | + | - [ ] New feature |
|
| 14 | + | - [ ] Template update |
|
| 15 | + | - [ ] Refactor |
|
| 16 | + | - [ ] Documentation |
|
| 17 | + | - [ ] CI/CD or tooling |
|
| 18 | + | ||
| 19 | + | ## Checklist |
|
| 20 | + | ||
| 21 | + | - [ ] Tests pass (`bun test`) |
|
| 22 | + | - [ ] Linting passes (`bun run lint:check`) |
|
| 23 | + | - [ ] Formatting passes (`bun run format:check`) |
|
| 24 | + | - [ ] Tested CLI output manually if applicable |
| 14 | 14 | ||
| 15 | 15 | ### Submitting a Pull Request |
|
| 16 | 16 | ||
| 17 | + | **Important:** Before starting work on a pull request, you must first [open an issue](https://github.com/stevedylandev/bhvr/issues/new) describing your proposed change and wait for it to be reviewed and approved. PRs without a corresponding approved issue will be closed. |
|
| 18 | + | ||
| 17 | 19 | 1. Fork the repository and create your branch from `main`. |
|
| 18 | 20 | 2. Run `bun install` to install the dependencies. |
|
| 19 | 21 | 3. Make your changes. |