Merge pull request #58 from crocofied/issue_templates

.github (Issue Templates & more)
This commit is contained in:
headlessdev 2025-04-28 15:57:04 +02:00 committed by GitHub
commit 245ffdd3dd
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
7 changed files with 168 additions and 0 deletions

43
.github/CODE_OF_CONDUCT.md vendored Normal file
View File

@ -0,0 +1,43 @@
# Code of Conduct
## Our Pledge
We as members, contributors, and leaders pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
## Our Standards
Examples of behavior that contributes to a positive environment for our community include:
- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
- The use of sexualized language or imagery, and unwelcome sexual attention or advances
- Trolling, insulting/derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email address, without their explicit permission
- Other conduct which could reasonably be considered inappropriate in a professional setting
## Our Responsibilities
Project leaders are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
## Scope
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [your email address or contact method here]. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant, version 2.1](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html), available at [https://www.contributor-covenant.org/](https://www.contributor-covenant.org/).

8
.github/CONTRIBUTING.md vendored Normal file
View File

@ -0,0 +1,8 @@
# How to Contribute
1. Fork the repository
2. Create a new branch
3. Make your changes
4. Submit a pull request
Please make sure your code passes all tests and follows the style guide.

1
.github/FUNDING.yml vendored Normal file
View File

@ -0,0 +1 @@
buy_me_a_coffee: corecontrol

67
.github/ISSUE_TEMPLATE/bug_report.yml vendored Normal file
View File

@ -0,0 +1,67 @@
name: 🐞 - Bug Report
description: Report a problem or unexpected behavior.
title: "[Bug]: "
labels: ["unverified bug"]
assignees: []
body:
- type: markdown
attributes:
value: |
Thank you for reporting a bug! Please fill out the information below.
- type: input
id: what-happened
attributes:
label: What happened?
description: Describe the issue you encountered.
placeholder: Tell us what happened...
validations:
required: true
- type: textarea
id: reproduction-steps
attributes:
label: Steps to reproduce
description: List the steps needed to reproduce the issue.
placeholder: |
1. Go to '...'
2. Click on '...'
3. Scroll down to '...'
4. See error
validations:
required: true
- type: dropdown
id: operating-system
attributes:
label: Operating System
options:
- Windows
- macOS
- Linux
- Other
validations:
required: true
- type: input
id: version
attributes:
label: Version
description: The version of the CoreControl you are using.
placeholder: e.g. v0.0.10
validations:
required: true
- type: input
id: logs
attributes:
label: Logs
description: The logs of the docker containers, if necessary.
placeholder: |
```
[logs]
```
validations:
required: false
- type: textarea
id: additional-info
attributes:
label: Additional Information
description: Add any other context about the problem here.
placeholder: Any extra details...

View File

@ -0,0 +1,41 @@
name: ✨ - Feature Request
description: Suggest a new idea or enhancement.
title: "[Feature]: "
labels: ["enhancement"]
assignees: []
body:
- type: markdown
attributes:
value: |
Thank you for suggesting a feature! Please provide as much detail as possible.
- type: input
id: feature-summary
attributes:
label: Feature Summary
description: Short summary of the feature you are requesting.
placeholder: A short and clear description...
validations:
required: true
- type: textarea
id: motivation
attributes:
label: Motivation
description: Why do you need this feature? What problem does it solve?
placeholder: Describe the use case...
validations:
required: true
- type: textarea
id: possible-solution
attributes:
label: Possible Solution
description: Suggest an idea for how the feature could be implemented (optional).
placeholder: Maybe something like this...
validations:
required: false
- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Add any other context, screenshots, or examples here.
placeholder: Other relevant information...

7
.github/PULL_REQUEST_TEMPLATE.md vendored Normal file
View File

@ -0,0 +1,7 @@
## Description
Please explain the changes you made.
## Checklist
- [ ] I have tested the code
- [ ] I have updated the documentation if necessary
- [ ] I followed the project's coding guidelines

1
.github/config.yml vendored Normal file
View File

@ -0,0 +1 @@
blank_issues_enabled: false