|
1 | 1 | # Contributing |
2 | 2 |
|
3 | | -Follow these guidelines if you'd like to contribute to the project! |
| 3 | +Hey there! Thanks for considering contributing to this project! We appreciate your interest and are excited to have you join our community of contributors. |
4 | 4 |
|
| 5 | +## How You Can Help |
5 | 6 |
|
6 | | -## Questions |
| 7 | +* **Report Bugs:** Found something that's not working as expected? Let us know! Clear and detailed bug reports are incredibly valuable. |
| 8 | +* **Suggest Features:** Got a brilliant idea for a new feature or improvement? We'd love to hear it! |
| 9 | +* **Submit Code:** Ready to roll up your sleeves and write some code? Awesome! Check out our coding style guidelines (see below) and dive in. |
| 10 | +* **Improve Documentation:** Documentation is just as important as code. Help us make it clear, concise, and easy to understand. |
| 11 | +* **Spread the Word:** Tell your friends, write blog posts, share on social media – help us get the word out! |
7 | 12 |
|
8 | | -If you have any questions about using or developing for this project, reach out to @bugfishtm. |
| 13 | +## Coding Style Guidelines |
9 | 14 |
|
10 | | -## Issues |
| 15 | +* Follow the existing coding style. |
| 16 | +* Write clear, concise, and well-commented code. |
| 17 | +* Keep your pull requests focused on a single issue or feature. |
11 | 18 |
|
12 | | -Submit an issue or pull request with a fix if you find any bugs in |
13 | | -the project. When submitting an issue or pull request, make sure you're as detailed as possible. |
| 19 | +## Code of Conduct |
14 | 20 |
|
15 | | -## Features |
| 21 | +Please note that this project has a Code of Conduct (.github/CODE_OF_CONDUCT.md). By participating in this project, you agree to abide by its terms. |
16 | 22 |
|
17 | | -Submit an issue to request a new feature. |
| 23 | +## Need Help? |
| 24 | + |
| 25 | +If you're having trouble getting started or have any questions, feel free to reach out to us! You can: |
| 26 | + |
| 27 | +* Open an issue here on GitHub. |
| 28 | +* Join our Discord at https://discord.com/invite/y5d2px9KEw. |
| 29 | +* Open a Topic on my Forum at https://www.bugfish.eu/forum. |
| 30 | + |
| 31 | +Thank you again for your interest in contributing! We look forward to working with you. |
18 | 32 |
|
19 | 33 | 🐟 Bugfish <3 |
0 commit comments