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

#10069 add new suggestion template #10091

Merged

Conversation

DS-INRAE
Copy link
Member

@DS-INRAE DS-INRAE commented Nov 3, 2023

What this PR does / why we need it:
Add a new issue template for suggestion to distinguish them from feature request at creation

Which issue(s) this PR closes:

Additional documentation:
Previous similar issue :

@DS-INRAE DS-INRAE marked this pull request as ready for review November 3, 2023 14:36
@pdurbin pdurbin added the Size: 0.5 A percentage of a sprint. 0.35 hours label Feb 28, 2024
Start below this comment section.
-->

**Overview of the Feature Request**
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we want to call this "Idea Suggestion" , not "Feature Request" here?

**Overview of the Feature Request**


**What kind of user is the feature intended for?**
Copy link
Contributor

Choose a reason for hiding this comment

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

Again, "suggestion" for "feature"?

**Any brand new behavior do you want to add to Dataverse?**


**Any open or closed issues related to this feature request?**
Copy link
Contributor

Choose a reason for hiding this comment

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

again, "idea or suggestion"?

@sekmiller
Copy link
Contributor

@DS-INRA Dimitri, it looks like there are cut and paste issues with the body of the template. Please take a look. Thanks!

@sekmiller sekmiller self-assigned this May 30, 2024
Copy link
Member

@pdurbin pdurbin left a comment

Choose a reason for hiding this comment

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

I'm just raising awareness of the upcoming Contributor Guide.

Comment on lines 13 to 14
More information on ideas/feature requests and contributions can be found in the "Contributing to Dataverse" page:
https://github.com/IQSS/dataverse/blob/develop/CONTRIBUTING.md#ideasfeature-requests
Copy link
Member

Choose a reason for hiding this comment

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

Heads up that in this PR we plan to move content from CONTRIBUTING.md to its own guide:

So that #ideasfeature-requests link won't work anymore.

@sekmiller sekmiller added the Status: Needs Input Applied to issues in need of input from someone currently unavailable label Jun 10, 2024
@sekmiller
Copy link
Contributor

@DS-INRA Dimitri when you have some time please let me know what you think about my comments/questions above. Thanks!

@DS-INRAE
Copy link
Member Author

@DS-INRA Dimitri when you have some time please let me know what you think about my comments/questions above. Thanks!

Hello, sorry for the long delay, I should have more time to get back on this after this week :)

@DS-INRAE
Copy link
Member Author

Thanks for the reviews!
I changed the "feature" mentions and updated the contributor's guide link (including in existing issue templates)
I also added the section:

**Will you be able to contribute a Pull Request for this issue?**  
Help is always welcome, is this bug something you or your organization plan to fix ?

to the existing issue templates, but can take it back if deemed irrelevant :)

Copy link
Contributor

@sekmiller sekmiller left a comment

Choose a reason for hiding this comment

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

Thanks for the updates, Dimitri. Looks good!

Copy link
Member

@pdurbin pdurbin left a comment

Choose a reason for hiding this comment

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

Just some thoughts.

@@ -53,3 +52,6 @@ To add a screenshot, please use one of the following formats and/or methods desc

* https://help.github.com/en/articles/file-attachments-on-issues-and-pull-requests
*

**Will you be able to contribute a Pull Request for this issue?**
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
**Will you be able to contribute a Pull Request for this issue?**
**Will you be able to contribute a pull request for this issue?**

Copy link
Member Author

Choose a reason for hiding this comment

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

changed with the last comment's rephrasing

.github/ISSUE_TEMPLATE/bug_report.md Outdated Show resolved Hide resolved
Comment on lines 37 to 38
**Will you be able to contribute a Pull Request for this issue?**
Help is always welcome, is this bug something you or your organization plan to fix ?
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
**Will you be able to contribute a Pull Request for this issue?**
Help is always welcome, is this bug something you or your organization plan to fix ?
**Will you be able to contribute a pull request for this issue?**
Help is always welcome, is this bug something you or your organization plan to fix?

Copy link
Member Author

Choose a reason for hiding this comment

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

changed with the last comment's rephrasing

Comment on lines 39 to 40
**Will you be able to contribute a Pull Request for this issue?**
Help is always welcome, is this suggestion something you or your organization plan to implement ?
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
**Will you be able to contribute a Pull Request for this issue?**
Help is always welcome, is this suggestion something you or your organization plan to implement ?
**Will you be able to contribute a pull request for this issue?**
Help is always welcome, is this suggestion something you or your organization plan to implement?

Copy link
Member Author

Choose a reason for hiding this comment

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

changed with the last comment's rephrasing

@@ -11,8 +11,7 @@ assignees: ''
Thank you for contributing to the Dataverse Project through the creation of a feature request!
Copy link
Member

Choose a reason for hiding this comment

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

Above, should we change

title: 'Feature Request/Idea:'

to just

title: 'Feature Request:'

? That is, remove "idea" now that we have a dedicate template for ideas?

Copy link
Member Author

Choose a reason for hiding this comment

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

Nice catch! I removed "Idea"

@@ -53,3 +52,6 @@ To add a screenshot, please use one of the following formats and/or methods desc

* https://help.github.com/en/articles/file-attachments-on-issues-and-pull-requests
*

Copy link
Member

Choose a reason for hiding this comment

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

At a high level, "Will you be able to contribute a pull request for this issue?" strikes me as somewhat strong.

What if they say "yes" but it doesn't work out? Will they feel bad?

Instead should we say something softer like "Are you thinking about creating a pull request for this issue?"

That way they won't feel as "on the hook", I would hope.

Copy link
Member Author

Choose a reason for hiding this comment

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

Sure, it does sound less intimidating

@DS-INRAE
Copy link
Member Author

@pdurbin I have updated the templates according to all the comments 🙂

@stevenwinship stevenwinship self-assigned this Jul 24, 2024
@stevenwinship stevenwinship merged commit 4abfb24 into IQSS:develop Jul 24, 2024
1 of 2 checks passed
@stevenwinship stevenwinship removed their assignment Jul 24, 2024
@pdurbin pdurbin added this to the 6.4 milestone Jul 24, 2024
@luddaniel luddaniel deleted the 10069-add-suggestion-template branch September 19, 2024 14:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Size: 0.5 A percentage of a sprint. 0.35 hours Status: Needs Input Applied to issues in need of input from someone currently unavailable
Projects
Status: Done 🧹
Status: 🚀 Done (Recherche Data Gouv)
Development

Successfully merging this pull request may close these issues.

Feature Request/Idea: Dissociate and label issue templates for Features & Ideas
5 participants