Skip to content

Commit 319efea

Browse files
author
bugfish\bugfishtm
committed
Changes
1 parent 7cc18e7 commit 319efea

File tree

9 files changed

+160
-23
lines changed

9 files changed

+160
-23
lines changed

.github/CODE_OF_CONDUCT.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
## Code of Conduct
2+
3+
### Our Pledge
4+
5+
We're building cool stuff for free to push technology forward. If you're here, you're part of that mission. Let's work together, share ideas, and make awesome things happen!
6+
7+
### Our Standards
8+
9+
* **Positive:** Be kind, empathetic, and respectful. Give constructive feedback.
10+
* **Unacceptable:** Harassment, offensive comments, personal attacks, sharing private info without consent.
11+
12+
🐟 Bugfish <3

.github/CONTRIBUTING.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Contributing
2+
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+
5+
## How You Can Help
6+
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!
12+
13+
## Coding Style Guidelines
14+
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.
18+
19+
## Code of Conduct
20+
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.
22+
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.
32+
33+
🐟 Bugfish <3

.github/ISSUE_TEMPLATE.md

Lines changed: 0 additions & 7 deletions
This file was deleted.
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
name: Bug Report
3+
about: Report a problem with the project.
4+
title: "[BUG] Short description of the issue"
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Do '....'
17+
3. See error
18+
19+
**Expected behavior**
20+
A clear and concise description of what you expected to happen.
21+
22+
**Screenshots**
23+
If applicable, add screenshots to help explain your problem.
24+
25+
**Environment:**
26+
- OS: [e.g. Windows, macOS, Linux]
27+
- Version [e.g. Software Version, Browser Version]
28+
29+
**Additional context**
30+
Add any other context about the problem here.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature Request
3+
about: Suggest a new feature or improvement for this project
4+
title: "[FEATURE] Short description of the feature"
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. "I'm always frustrated when..."
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Visit my Forum
4+
url: https://www.bugfish.eu/forum
5+
about: Please ask and answer questions there.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,22 @@
1-
Please provide information:
1+
## Description
2+
[Provide a brief description of the changes in this pull request]
23

3-
- Details: Provide details about your pull request and what it adds, fixes, or changes.
4-
- Issues fixed: Enter the issue numbers resolved by this pull request below, if any.
4+
## Related Issue
5+
[Reference any related issue(s) here using the syntax: Fixes #123 or Relates to #456]
56

6-
Please check your request:
7+
## Proposed Changes
8+
- [Change 1]
9+
- [Change 2]
10+
- [Change 3]
711

8-
1. This is not a duplicate of an existing pull request.
9-
2. No existing features have been broken without good reason.
10-
3. Your commit messages are detailed.
12+
## Additional Information
13+
[Any additional information or context that would be helpful for reviewers]
1114

12-
Any questions should be directed to @bugfishtm.
15+
## Checklist
16+
- [ ] I have tested these changes locally
17+
- [ ] I have updated the documentation accordingly
18+
- [ ] My code follows the project's coding standards
19+
- [ ] I have added/updated tests for this change
20+
21+
## Screenshots (if applicable)
22+
[Add screenshots here to demonstrate visual changes]

CONTRIBUTING.md

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,33 @@
11
# Contributing
22

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.
44

5+
## How You Can Help
56

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!
712

8-
If you have any questions about using or developing for this project, reach out to @bugfishtm.
13+
## Coding Style Guidelines
914

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.
1118

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
1420

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.
1622

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.
1832

1933
🐟 Bugfish <3

SECURITY.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
## Security Policy
2+
3+
### Reporting a Vulnerability
4+
5+
We take the security of our project seriously. If you discover a security vulnerability, please follow these steps:
6+
7+
1. **Do not** create a public GitHub issue for the vulnerability.
8+
2. Email your findings to [email protected]
9+
3. Provide as much information as possible, including:
10+
- A description of the vulnerability
11+
- Steps to reproduce
12+
- Potential impact
13+
14+
### What to Expect
15+
16+
- We will acknowledge receipt of your report.
17+
- We will strive to keep you informed about the progress of addressing the issue.
18+
- Once the vulnerability is confirmed and fixed, we will inform you.
19+
20+
🐟 Bugfish <3

0 commit comments

Comments
 (0)