Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Issue Template improvements and Contact Info #16

Merged
merged 4 commits into from
Jun 8, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions .github/ISSUE_TEMPLATE/ask-a-question.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@ name: Ask a question
about: Ask a question about this project or anything printing-related
title: "[QUESTION]"
labels: question
assignees: ''

assignees: ""
---

**Is your feature request related to a problem? Please describe.**
Expand All @@ -28,3 +27,16 @@ Please provide a summary of any steps you have attempted already.
- Where you looked/google searches you performed.

> Make an effort to try to solve the problem yourself first before opening a ticket.

**Additional context**
If applicable, include any other context or screenshots about the feature request here.

**Checklist**

- [ ] I have included a clear description of the question
- [ ] I have included a description of my hypothesis
- [ ] I have included a summary of the steps I've taken already
- [ ] I have included any relevant screenshots or videos
- [ ] I have included any other context about the question here
- [ ] I have made an effort to try to solve the problem myself first before opening a ticket
- [ ] I have remembered to stay calm and have fun!
16 changes: 12 additions & 4 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,16 +21,24 @@ Please provide detailed steps to reproduce the issue, including any relevant con
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots or videos to help explain your problem.
If applicable, attach screenshots or videos to help explain your problem.

**Klippy log**
If applicable, add your Klipper log to help diagnose the problem.
Please attach your Klipper log to help diagnose the problem.

**Klipper Config**
If applicable, add your Klipper config to help diagnose the problem.
If applicable, attach your Klipper config to help diagnose the problem.

**Other Files**
If applicable, add any other files such as gcode files or stl files to help diagnose the problem.
If applicable, attach any other files such as gcode files or stl files to help diagnose the problem.

**Additional context**
Add any other context about the problem here.

**Checklist**

- [ ] I have included a clear description of the bug
- [ ] I have included detailed steps to reproduce the issue
- [ ] I have included any relevant configuration settings or input files
- [ ] I have included any relevant screenshots or videos
- [ ] I have included my Klipper log
10 changes: 8 additions & 2 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@ name: Feature request
about: Suggest an idea for this project
title: "[FEATURE]"
labels: enhancement
assignees: ''

assignees: ""
---

**Is your feature request related to a problem? Please describe.**
Expand All @@ -18,3 +17,10 @@ A clear and concise description of any alternative solutions or features you've

**Additional context**
Add any other context or screenshots about the feature request here.

**Checklist**

- [ ] I have included a clear description of the feature
- [ ] I have included a description of the solution
- [ ] I have included any alternative solutions or features I've considered
- [ ] I have included any relevant screenshots or videos
42 changes: 42 additions & 0 deletions .github/ISSUE_TEMPLATE/submit_profile.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
name: Submit Profile
about: Submit a profile to be added to the repository
title: "[PROFILE]"
labels: enhancement
assignees: ""
---

**Provide the name of your profile.**
The profile name should be short and not contain any spaces or special characters.
It should also be unique and not conflict with any existing profiles.
The profile name should be all lowercase.
Please also refrain from using any offensive or discriminatory language in your profile name or description.

**Provide a short description of your profile.**
The description should be short and concise. Describe what configuration this profile is for. Include any special features or hardware that this profile supports.

**List the relevant hardware**
Describe the hardware that this profile is for.
This should include the printer, probe, kinematics, and any other relevant hardware.

**A short paragraph on why this profile should be added**
Describe why this profile should be added to the repository. The profile should be unique and not conflict with any existing profiles. The bar is low, don't be intimidated.

**Additional context**
Add any other context or screenshots about the feature request here.

**Profile Files**
Please include the following files in your profile submission:

- `config.cfg`
- `variables.cfg`
- `README.md`

The `README.md` file should contain the same information as this issue template. You may use any GitHub Markdown features you wish. Please include a note of it and attach any images you wish to use in the `README.md` file to this issue.

- **Checklist**
- [ ] I have included a unique profile name
- [ ] I have included a short description of the profile
- [ ] I have included a list of relevant hardware
- [ ] I have included a short paragraph on why this profile should be added
- [ ] I have included the necessary profile files
Loading