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

New Issue Templates #1056

Merged
6 commits merged into from Dec 25, 2020
Merged

New Issue Templates #1056

6 commits merged into from Dec 25, 2020

Conversation

Silverarmor
Copy link
Member

No description provided.

@Silverarmor
Copy link
Member Author

As per earlier discussion @MikhailZex, I have drafted a feature request template, to deprecate using #867.
Please provide any feedback. Feel free to commit to the issue-template-updates branch

@Silverarmor Silverarmor added the Enhancement Enhancing spotDL label Dec 23, 2020
@Silverarmor Silverarmor requested a review from a user December 25, 2020 00:29
@Silverarmor Silverarmor marked this pull request as ready for review December 25, 2020 00:29
@Silverarmor
Copy link
Member Author

@MikhailZex requesting urgent review. The new config prevents users from opening an issue without using a template.
Draft Feature Request template also included in this PR.

@ghost
Copy link

ghost commented Dec 25, 2020

You can still open a blank issue

Screenshot_20201225-094526_GitHub.jpg

Screenshot_20201225-094520_GitHub.jpg

@Silverarmor
Copy link
Member Author

Yeah github only takes the config file from the master branch. Once the PR is merged then you won't be able to make template-less issues

@ghost
Copy link

ghost commented Dec 25, 2020

@MikhailZex requesting urgent review. The new config prevents users from opening an issue without using a template.
Draft Feature Request template also included in this PR.

Ok. Are you trying to enforce templates or allow template-less issues?

@Silverarmor
Copy link
Member Author

Silverarmor commented Dec 25, 2020

Enforce templates.

Prevent issues like #1050 from happening etc.

Copy link

@ghost ghost left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very minor changes to be made.


## Solution
<!--- How can we fix this problem? Describe the feature you are requesting. -->
<!--- Address Pros & Cons of the feature. If you present multiple solutions, please state them separately, and compare at the end -->
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This might be a little overkill. Something along the lines of "describe a possible implementation you have in mind (if you do have any ideas as of now)"


## Examples/Research
<!--- Have you tried to solve your problem? -->
<!--- Can you provide code examples, diagrams or any other information to support the Feature Request? -->
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Most people wouldn't do this. Drop it.

## Purpose
<!--- Describe the problem or feature in addition to a link to the issues. -->

## Approach
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

## Design would be more apt.

<!--- Describe the problem or feature in addition to a link to the issues. -->

## Approach
<!--- How does this change address the problem? -->
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Force simplicity "Describe then solution implemented in around 50 words. Please be specific."

The current phrasing is open to vague replies.

<!--- Change the title to summarise simply and succintly. -->

## Problem
<!--- IMPORTANT: Why do we need to implement this feature? How would it help you? -->
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

*how would this help other users?

Features that help only few users won't be implemented. They can fork spotDL, make changes and will link those in the readme.

@ghost ghost merged commit b7a517b into master Dec 25, 2020
@ghost ghost deleted the issue-template-updates branch December 28, 2020 18:13
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Enhancement Enhancing spotDL
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant