Skip to content

Commit

Permalink
Merge pull request #982 from Atlas-OS/issues
Browse files Browse the repository at this point in the history
Better issue and PR template
  • Loading branch information
Xyueta authored Dec 4, 2023
2 parents 192b372 + 3ef1a54 commit 78a8d56
Show file tree
Hide file tree
Showing 8 changed files with 35 additions and 102 deletions.
47 changes: 18 additions & 29 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -1,13 +1,16 @@
name: Bug report
description: Create a bug report to help us improve Atlas.
labels: bug
title: "[BUG REPORT] - "
title: "[BUG] - "
body:
- type: markdown
attributes:
value: |
A clear and brief description of what the bug is.
Before submitting an issue, please ensure you have completed the following steps:
- Reviewed our [documentation](https://docs.atlasos.net).
- Searched our [issue tracker](https://github.com/Atlas-OS/Atlas/issues?q=is%3Aissue) to verify that the issue hasn't been reported already.
- Confirmed that your issue is not a support request.
Please note, by submitting an issue, you acknowledge that if the above steps have not been followed, the maintainers reserve the right to close and lock your issue without further response.
- type: textarea
attributes:
label: Description
Expand All @@ -17,7 +20,8 @@ body:

- type: textarea
attributes:
label: Steps to reproduce (add screenshots if applicable)
label: Steps to reproduce
description: The steps required to reproduce this bug (add screenshots if applicable).
placeholder: |
1. [First step] (Screenshot 1)
2. [Second step] (Screenshot 2)
Expand All @@ -28,23 +32,23 @@ body:
- type: textarea
attributes:
label: Expected behavior
description: What you expected to happen.
description: What you expect to happen (add screenshots if applicable).
validations:
required: true

- type: textarea
attributes:
label: Actual behavior (add screenshots if applicable)
description: What happened.
label: Actual behavior
description: What actually happened (add screenshots if applicable).
validations:
required: true

- type: dropdown
attributes:
label: Atlas Version
label: Atlas Edition
options:
- Atlas 10 22H2
- Atlas 11 23H2
- Atlas for Windows 10 22H2
- Atlas for Windows 11 23H2
validations:
required: true

Expand All @@ -53,28 +57,13 @@ body:
label: Desktop information
description: Your hardware specification is needed for us to define the problem.
placeholder: |
- Processor [include brand and specifics]
- RAM amount
- Storage [include brand and type]
- Graphics card [include driver version]
- Processor [include brand and specs]
- RAM [include size and generation]
- Storage [include size, brand, and type]
- GPU [include brand, specs, driver version]
validations:
required: true

- type: checkboxes
attributes:
label: Requisites
description: |
To rule out invalid issues, confirm and check each one of the checkboxes.
options:
- label: This is not a support issue or a question. For any support, questions or help, join our [Discord server](https://discord.atlasos.net).
required: true
- label: I performed a [cursory search of the issue tracker](https://github.com/Atlas-OS/Atlas/issues?q=is%3Aissue) to avoid opening a duplicate issue.
required: true
- label: I checked the [documentation](https://docs.atlasos.net) to understand that the issue I am reporting is not normal behavior.
required: true
- label: I understand that not filling out this template correctly will lead to the issue being closed.
required: true

- type: textarea
attributes:
label: Additional content
Expand Down
16 changes: 5 additions & 11 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,14 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: General discussions
url: https://discord.atlasos.net
about: Please join our Discord server for general discussions.
- name: General discussions (if you do not use Discord)
url: https://forum.atlasos.net
about: Use our forum for general discussions.
- name: Contribute to Atlas Documentation
url: https://github.com/Atlas-OS/docs
about: Contribute to Atlas Documentation in this repository.
- name: Report Issue about Atlas Documentation
url: https://github.com/Atlas-OS/docs/issues/
about: Report all Documentation issues in our Documentation repository issue tracker.
- name: Report an issue (non-Atlas related issue)
url: https://forum.atlasos.net
about: Please report any non-Atlas related issue in our ``Bug Report`` section on our Forum (Website, Discord bot, etc.).
url: https://forum.atlasos.net/t/atlas-bug-report
about: Please report any non-Atlas Playbook related issue in the ``Bug Report`` section on our Forum (Website, Discord bot, etc.).
40 changes: 10 additions & 30 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -1,45 +1,38 @@
name: Feature request
description: Create a feature request to help us improve Atlas.
labels: enhancement
title: "[FEATURE REQUEST] - "
title: "[FEATURE] - "
body:
- type: markdown
attributes:
value: |
A clear and brief description of your feature request.
Before submitting an feature request, please ensure you have completed the following steps:
- The request you submit is related to the Atlas Playbook. If not, request it in our [forum](https://forum.atlasos.net/t/general).
- Searched our [issue tracker](https://github.com/Atlas-OS/Atlas/issues?q=is%3Aissue) to verify that the issue hasn't been reported already.
- Confirmed that your issue is not a support request.
Please note, by submitting an issue, you acknowledge that if the above steps have not been followed, the maintainers reserve the right to close and lock your issue without further response.
- type: dropdown
attributes:
label: What is your feature request regarding to?
options:
- AtlasOS
- README
- Documentation
- Other, specify below
- Atlas Playbook
- Other (submit it in https://forum.atlasos.net)
validations:
required: true

- type: input
attributes:
label: Other
description: Only enter if you chose "Other"
placeholder: |
e.g. the...
validations:

- type: textarea
attributes:
label: Is your feature request related to a problem? Please describe.
placeholder: |
A clear and brief description of what the problem is.
e.g. I always wanted Atlas to...
validations:
required: true

- type: textarea
attributes:
label: Describe the solution you would like.
placeholder: |
A clear and brief description of what you want to happen.
e.g. I would like Atlas to add...
validations:
required: true

Expand All @@ -50,19 +43,6 @@ body:
validations:
required: true

- type: checkboxes
attributes:
label: Requisites
description: |
To rule out invalid issues, confirm and check each one of the checkboxes.
options:
- label: This is not a support issue or a question. For any support, questions or help, join our [Discord server](https://discord.atlasos.net).
required: true
- label: I performed a [cursory search of the issue tracker](https://github.com/Atlas-OS/Atlas/issues?q=is%3Aissue) to avoid opening a duplicate issue.
required: true
- label: I understand that not filling out this template will lead to the issue being closed.
required: true

- type: textarea
attributes:
label: Additional context.
Expand Down
9 changes: 0 additions & 9 deletions .github/PULL_REQUEST_TEMPLATE/Bugfix.md

This file was deleted.

15 changes: 0 additions & 15 deletions .github/PULL_REQUEST_TEMPLATE/Enhancement.md

This file was deleted.

6 changes: 0 additions & 6 deletions .github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md

This file was deleted.

3 changes: 1 addition & 2 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,5 @@
- [ ] Did you read and follow the [Atlas Contribution Guidelines](https://docs.atlasos.net/contributions/)?
- [ ] Did you commit to the [`dev`](https://github.com/Atlas-OS/Atlas/tree/dev) branch and not [`main`](https://github.com/Atlas-OS/Atlas)?

**Note:** You should commit directly to `main` for translations of the `README.md`.

### Describe your pull request

1 change: 1 addition & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Contribution Guidelines is on our [Documentation](https://docs.atlasos.net/contributions/).

0 comments on commit 78a8d56

Please sign in to comment.