feat: Added CONTRIBUTING.md
2f32d435
1 file(s) · +25 −0
| 1 | + | # Contributing to create-bhvr |
|
| 2 | + | ||
| 3 | + | First off, thank you for considering contributing to `bhvr`! This is a true open source project and we welcome community ideas and contributions. In order to keep things clean please follow the contributing guidelines below. |
|
| 4 | + | ||
| 5 | + | ## How Can I Contribute? |
|
| 6 | + | ||
| 7 | + | ### Reporting Bugs |
|
| 8 | + | ||
| 9 | + | If you find a bug, please make sure the bug has not already been reported by searching on GitHub under [Issues](https://github.com/stevedylandev/bhvr/issues). If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/stevedylandev/bhvr/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring. |
|
| 10 | + | ||
| 11 | + | ### Suggesting Enhancements |
|
| 12 | + | ||
| 13 | + | If you have an idea for an enhancement, please make sure the enhancement has not already been suggested by searching on GitHub under [Issues](https://github.com/stevedylandev/bhvr/issues). If you're unable to find an open issue addressing the suggestion, [open a new one](https://github.com/stevedylandev/bhvr/issues/new). Be sure to include a **title and clear description** of the enhancement you're suggesting. |
|
| 14 | + | ||
| 15 | + | ### Submitting a Pull Request |
|
| 16 | + | ||
| 17 | + | 1. Fork the repository and create your branch from `main`. |
|
| 18 | + | 2. Run `bun install` to install the dependencies. |
|
| 19 | + | 3. Make your changes. |
|
| 20 | + | 4. Run `bun run build` to make sure your changes build correctly. |
|
| 21 | + | 5. Issue that pull request! |
|
| 22 | + | ||
| 23 | + | ## License |
|
| 24 | + | ||
| 25 | + | By contributing, you agree that your contributions will be licensed under its MIT License. |