Skip to content

Commit

Permalink
docs: Overhaul of feature request and issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
steilerDev committed Jul 7, 2023
1 parent 81fdccf commit d90c572
Show file tree
Hide file tree
Showing 4 changed files with 106 additions and 41 deletions.
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: Feature Request
description: Suggest an idea for this project
labels: ["class(feature)", "status(open)"]
body:
- type: textarea
id: ultimate-goal
attributes:
label: Describe the ultimate goal you want to achieve
description: Describe the use case and motivation for this request.
validations:
required: true
- type: textarea
id: proposal
attributes:
label: How do you think the feature should be implemented
description: Describe the user facing and/or technical implementation approaches (if applicable).
- type: checkboxes
id: terms
attributes:
label: Checklist
description: Before submitting this issue, make sure you completed the following steps
options:
- label: This is a [feature request](https://github.com/steilerDev/icloud-photos-sync/blob/main/CONTRIBUTING.md#feature), not an [issue](https://github.com/steilerDev/icloud-photos-sync/blob/beta/CONTRIBUTING.md#issue) or [a question](https://github.com/steilerDev/icloud-photos-sync/blob/main/CONTRIBUTING.md#question)
required: true
- label: I accept the [Code of Conduct](https://github.com/steilerDev/icloud-photos-sync/blob/main/CODE_OF_CONDUCT.md)
required: true
39 changes: 0 additions & 39 deletions .github/ISSUE_TEMPLATE/issue-template.md

This file was deleted.

69 changes: 69 additions & 0 deletions .github/ISSUE_TEMPLATE/issue.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
name: Bug Report
description: Create a report to help us improve
labels: ["class(bug)", "status(open)"]
body:
- type: textarea
id: describe-issue
attributes:
label: Describe the issue
description: A clear and concise description of what the issue is.
validations:
required: true
- type: textarea
id: reproduction
attributes:
label: How to reproduce the behavior?
description: Steps how to reproduce the bug you are experiencing, also consider the properties of your iCloud Photo Library (e.g. size, age).
validations:
required: false
- type: input
id: error-code
attributes:
label: Error Code
description: Provide the error code, generate upon crash
placeholder: ex. 01234567-89ab-cdef-0123-456789abcdef
validations:
required: true
- type: textarea
id: logs
attributes:
label: Relevant log output
description: 'Please copy and paste any relevant log output (with `LOG_LEVEL=debug`), located in `.icloud-photos-sync.log`, stored in the user specified `DATA_DIR`'
render: shell-script
validations:
required: true
- type: input
id: os
attributes:
label: Operating system
placeholder: ex. Debian 10
validations:
required: true
- type: input
id: environment
attributes:
label: Execution environment
placeholder: ex. docker
validations:
required: true
- type: input
id: version
attributes:
label: icloud-photos-sync version
placeholder: ex. 1.0.1-beta.1
validations:
required: true
- type: checkboxes
id: terms
attributes:
label: Checklist
description: Before submitting this issue, make sure you completed the following steps
options:
- label: This is an [issue](https://github.com/steilerDev/icloud-photos-sync/blob/beta/CONTRIBUTING.md#-found-a-bug) and not [a question](https://github.com/steilerDev/icloud-photos-sync/blob/main/CONTRIBUTING.md#question) or [feature request](https://github.com/steilerDev/icloud-photos-sync/blob/main/CONTRIBUTING.md#feature)
required: true
- label: The sync was performed a couple of times and the issue is persisting and consistent
required: true
- label: Checked out [known issues](https://github.com/steilerDev/icloud-photos-sync/labels/class(known%20issue))
required: true
- label: Enabled [crash and error reporting](https://steilerdev.github.io/icloud-photos-sync/user-guides/error-reporting/)
required: true
13 changes: 11 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,9 @@ If you find a bug in the application, you can help us by [submitting an issue](#


## <a name="feature"></a> Missing a Feature?
You can *request* a new feature by [submitting an issue](#submit-issue).

You can *request* a new feature by [submitting a feature request](#submit-feature-request).

If you would like to *implement* a new feature, please consider the size of the change in order to determine the right steps to proceed:

* For a **Major Feature**, first open an issue and outline your proposal so that it can be discussed.
Expand All @@ -49,10 +51,17 @@ Before you submit an issue, please search the [issue tracker](https://github.com

We want to fix all the issues as soon as possible, but before fixing a bug, we need to reproduce and confirm it. In order to reproduce bugs, we require that you provide the error code displayed during runtime as well as the log file generated during the execution (preferably at `DEBUG` level).

You can file new issues by selecting from our [new issue templates](https://github.com/steilerDev/icloud-photos-sync/issues/new/choose) and filling out the issue template.
You can file a new issue by selecting the [bug report template from the issue templates](https://github.com/steilerDev/icloud-photos-sync/issues/new/choose) and filling it out.

In case you are experiencing multiple issues, please make sure to open a separate issue for each of them, so we can properly track and address them!

### <a name="submit-feature-request"></a> Submitting a Feature Request

Before you submit a feature request, please search the [issue tracker](https://github.com/steilerDev/icloud-photos-sync/issues). An similar request for your ultimate goal might already exist.

As this is a personal project, not all feature request will be considered. Additionally achieving your ultimate goal might be done in various ways, be open to possible implementations and make sure you can formulate your use case precisely.

You can file new feature request by selecting the [feature request template from the issue templates](https://github.com/steilerDev/icloud-photos-sync/issues/new/choose) and fill it out.

### <a name="submit-pr"></a> Submitting a Pull Request (PR)

Expand Down

0 comments on commit d90c572

Please sign in to comment.