Issue template form #16349

Merged
redstonedesigner merged 27 commits from issue-template-form into main 2021-09-15 17:33:13 +00:00
redstonedesigner commented 2021-07-06 10:21:55 +00:00 (Migrated from github.com)

This pull request removes the old file, located at .github/issue_template.md (this is a legacy method of defining issue templates).
The new method of creating an issue template also allows for forms to be created when users are submitting an issue. When creating the issue template, I have used the current issue template as closely as possible.
This pull request also disables blank issue creation, meaning that all new issues must use the form(s) configured to submit an issue.

This form can be tested by going to https://github.com/redstonedesigner/gitea-issue-form-testing and creating a new issue.

This pull request removes the old file, located at .github/issue_template.md (this is a legacy method of defining issue templates). The new method of creating an issue template also allows for forms to be created when users are submitting an issue. When creating the issue template, I have used the current issue template as closely as possible. This pull request also disables blank issue creation, meaning that all new issues must use the form(s) configured to submit an issue. This form can be tested by going to https://github.com/redstonedesigner/gitea-issue-form-testing and creating a new issue.
delvh reviewed 2021-07-06 11:18:53 +00:00
delvh left a comment
Contributor

Well done 👍

Well done :+1:
Contributor

I don't think the git version should be required.
Until now, most of the issues I opened could be managed without knowing the git version. Additionally, doing it that way disables sending bugs present on try.gitea.io as I have no idea what git version is running there.

I don't think the git version should be required. Until now, most of the issues I opened could be managed without knowing the git version. Additionally, doing it that way disables sending bugs present on try.gitea.io as I have no idea what git version is running there.
Contributor

I'd also say that the OS is not required, at least for issues that deal with the frontend.

I'd also say that the OS is not required, at least for issues that deal with the frontend.
Contributor

Also not always required. What should I say about try.gitea.io?

Also not always required. What should I say about try.gitea.io?
Contributor

Once again: try.gitea.io. Should not be required.
Also, not required for pure frontend issues.

Once again: try.gitea.io. Should not be required. Also, not required for pure frontend issues.
Contributor

Okay, here it is a little different. I can see why you would require it here.

Okay, here it is a little different. I can see why you would require it here.
Contributor

Yes, here it can be required.

Yes, here it can be required.
delvh reviewed 2021-07-06 11:25:47 +00:00
Contributor

Is there maybe a way so that the placeholder will also be used as default?
Because currently, it is only displayed when no text is present.
GitHub still requires you to fill that field before you can submit the issue.

Is there maybe a way so that the placeholder will also be used as default? Because currently, it is only displayed when no text is present. GitHub still requires you to fill that field before you can submit the issue.
redstonedesigner (Migrated from github.com) reviewed 2021-07-06 11:26:00 +00:00
redstonedesigner (Migrated from github.com) commented 2021-07-06 11:26:00 +00:00

As far as I am aware, try.gitea.io is a testing environment only. There is a section below regarding using try.gitea.io to test things that you find on your own installations.
This is more checking wheter they are using https://gitea.com, another hosted environment or their own self hosted variation.
I can remove the required flag from this input, however I bleieve that it would be valuable information for users to provide in terms of where they are using Gitea.

As far as I am aware, try.gitea.io is a testing environment only. There is a section below regarding using try.gitea.io to test things that you find on your own installations. This is more checking wheter they are using https://gitea.com, another hosted environment or their own self hosted variation. I can remove the required flag from this input, however I bleieve that it would be valuable information for users to provide in terms of where they are using Gitea.
redstonedesigner (Migrated from github.com) reviewed 2021-07-06 11:27:12 +00:00
redstonedesigner (Migrated from github.com) commented 2021-07-06 11:27:12 +00:00

I can indeed specify a default value, however this would need to be updated every release.

I can indeed specify a default value, however this would need to be updated every release.
redstonedesigner (Migrated from github.com) reviewed 2021-07-06 11:28:05 +00:00
redstonedesigner (Migrated from github.com) commented 2021-07-06 11:28:05 +00:00

I see your point there, in my next commit this will be patched.

I see your point there, in my next commit this will be patched.
redstonedesigner (Migrated from github.com) reviewed 2021-07-06 11:28:38 +00:00
redstonedesigner (Migrated from github.com) commented 2021-07-06 11:28:38 +00:00

Agreed. I'll disable the requirement in my next commit.

Agreed. I'll disable the requirement in my next commit.
delvh reviewed 2021-07-06 11:28:53 +00:00
Contributor

Yeah, I know.
But the comfort of try.gitea.com is exactly that the latest features can already be tested. And sometimes, there are bugs in these new features. Then, you can refer to try.gitea.com for these bugs.
That's what I mean by that.

Yeah, I know. But the comfort of try.gitea.com is exactly that the latest features can already be tested. And sometimes, there are bugs in these new features. Then, you can refer to try.gitea.com for these bugs. That's what I mean by that.
redstonedesigner (Migrated from github.com) reviewed 2021-07-06 11:29:56 +00:00
redstonedesigner (Migrated from github.com) commented 2021-07-06 11:29:56 +00:00

To the best of my knowledge, try.gitea.io is a testing environment only and should only be used for reproducing bugs and trying out gitea.
I think that this would be valuable information for contributors and collaborators to have, so instead of disabling the requirement I might add something that prompts the person to write if they are using try.gitea.io .
Thoughts?

To the best of my knowledge, try.gitea.io is a testing environment only and should only be used for reproducing bugs and trying out gitea. I think that this would be valuable information for contributors and collaborators to have, so instead of disabling the requirement I might add something that prompts the person to write if they are using try.gitea.io . Thoughts?
redstonedesigner (Migrated from github.com) reviewed 2021-07-06 11:30:22 +00:00
redstonedesigner (Migrated from github.com) commented 2021-07-06 11:30:22 +00:00

Removed in next commit.

Removed in next commit.
delvh reviewed 2021-07-06 11:30:54 +00:00
Contributor

But the placeholder not?

But the placeholder not?
delvh reviewed 2021-07-06 11:35:05 +00:00
Contributor

Okay, sounds fine.
Since I am most likely affected the most by this (I'd say that I am the person with the highest count of issues opened from testing on try.gitea.com) that sounds reasonable.
Yeah, I can support that.

Okay, sounds fine. Since I am most likely affected the most by this (I'd say that I am the person with the highest count of issues opened from testing on try.gitea.com) that sounds reasonable. Yeah, I can support that.
delvh reviewed 2021-07-06 11:36:30 +00:00
delvh approved these changes 2021-07-06 11:36:44 +00:00
redstonedesigner (Migrated from github.com) reviewed 2021-07-06 11:42:12 +00:00
redstonedesigner (Migrated from github.com) commented 2021-07-06 11:42:12 +00:00

The placeholder could also be updated, however I consider placeholders as example values and not the value that a user should enter.

The placeholder could also be updated, however I consider placeholders as example values and not the value that a user should enter.
delvh approved these changes 2021-07-06 13:01:19 +00:00
delvh left a comment
Contributor

👍

:+1:
Contributor

Then this issue type would most likely be Bug Report, or something similar…

Then this issue type would most likely be `Bug Report`, or something similar…
redstonedesigner (Migrated from github.com) reviewed 2021-07-06 13:04:04 +00:00
redstonedesigner (Migrated from github.com) commented 2021-07-06 13:04:04 +00:00

Should now be resolved in the latest commit. I also changed the file name and description to be more in line with a bug report.

Should now be resolved in the latest commit. I also changed the file name and description to be more in line with a bug report.
a1012112796 (Migrated from github.com) reviewed 2021-07-06 13:27:16 +00:00
a1012112796 (Migrated from github.com) commented 2021-07-06 13:27:16 +00:00
blank_issues_enabled: true

Suggest enable it.

```suggestion blank_issues_enabled: true ``` Suggest enable it.
redstonedesigner (Migrated from github.com) reviewed 2021-07-06 13:28:31 +00:00
redstonedesigner (Migrated from github.com) commented 2021-07-06 13:28:31 +00:00

If this were to be enabled, people would have the ability to create blank issues without providing any formatting or guidance at all.

If this were to be enabled, people would have the ability to create blank issues without providing any formatting or guidance at all.
a1012112796 (Migrated from github.com) reviewed 2021-07-06 13:31:03 +00:00
a1012112796 (Migrated from github.com) commented 2021-07-06 13:31:03 +00:00

Sometimes it's usefull, such as create a summary or a vote.

Sometimes it's usefull, such as create a summary or a vote.
jpraet reviewed 2021-07-06 18:33:04 +00:00
Contributor

I don't think we should have a default value. And maybe not a placeholder either. I fear users will leave the default value unchanged, without confirming they are actually using that version.

I don't think we should have a default value. And maybe not a placeholder either. I fear users will leave the default value unchanged, without confirming they are actually using that version.
delvh reviewed 2021-07-06 22:44:35 +00:00
Contributor

Okay, I can live with both. I would have liked it, but I can also see your concern…

Okay, I can live with both. I would have liked it, but I can also see your concern…
redstonedesigner (Migrated from github.com) reviewed 2021-07-07 09:43:02 +00:00
redstonedesigner (Migrated from github.com) commented 2021-07-07 09:43:02 +00:00

I removed the placeholder and default version in my recent commit.

I removed the placeholder and default version in my recent commit.
jpraet reviewed 2021-07-08 20:18:16 +00:00
@ -0,0 +4,4 @@
- type: markdown
attributes:
value: |
NOTE: If your issue is a security concern, please send an email to security@gitea.io instead of opening a public issue.
Contributor

Should this still be here now that we have it already on the new issue landing page with the config.yaml?
Maybe an extra reminder here is not that bad.

Should this still be here now that we have it already on the new issue landing page with the config.yaml? Maybe an extra reminder here is not that bad.
@ -0,0 +9,4 @@
attributes:
value: |
1. Please speak English, this is the language all maintainers can speak and write.
2. Please ask questions or configuration/deploy problems on our Discord
Contributor

Should this still be here now that we have it already on the new issue landing page with the config.yaml?

Should this still be here now that we have it already on the new issue landing page with the config.yaml?
@ -0,0 +12,4 @@
2. Please ask questions or configuration/deploy problems on our Discord
server (https://discord.gg/gitea) or forum (https://discourse.gitea.io).
3. Please take a moment to check that your issue doesn't already exist.
4. Make sure it's not mentioned in the FAQ (https://docs.gitea.io/en-us/faq)
Contributor

Should this still be here now that we have it already on the new issue landing page with the config.yaml?

Should this still be here now that we have it already on the new issue landing page with the config.yaml?
@ -0,0 +86,4 @@
id: screenshots
attributes:
label: Screenshots
description: If this issue involves the Web Interface, please provide a screenshot or multiple screenshots
Contributor

Should we add an input field asking for the browser version for issues that involve the web interface?

Should we add an input field asking for the browser version for issues that involve the web interface?
@ -0,0 +1,23 @@
name: Feature Request
description: Got an idea for a feature that Gitea doesn't have currently? Submit your idea here!
body:
Contributor

We should also add some notes here about using the English language, and about checking first that the feature hasn't already been requested.

We should also add some notes here about using the English language, and about checking first that the feature hasn't already been requested.
redstonedesigner (Migrated from github.com) reviewed 2021-07-08 20:50:31 +00:00
@ -0,0 +4,4 @@
- type: markdown
attributes:
value: |
NOTE: If your issue is a security concern, please send an email to security@gitea.io instead of opening a public issue.
redstonedesigner (Migrated from github.com) commented 2021-07-08 20:50:30 +00:00

Too many reminders is never a bad thing if it stops security vulnerabilities being made public.
Ideally, it will make people reporting bugs think more than once, and that's if they even read far enough down.

Too many reminders is never a bad thing if it stops security vulnerabilities being made public. Ideally, it will make people reporting bugs think more than once, and that's if they even read far enough down.
delvh reviewed 2021-07-08 21:55:54 +00:00
@ -0,0 +86,4 @@
id: screenshots
attributes:
label: Screenshots
description: If this issue involves the Web Interface, please provide a screenshot or multiple screenshots
Contributor

Now that I think about it, it might not be a bad idea to completely separate issues involving web interface bugs from the rest of the bugs…
The report requirements might differ too much.

Now that I think about it, it might not be a bad idea to completely separate issues involving web interface bugs from the rest of the bugs… The report requirements might differ too much.
techknowlogick reviewed 2021-07-09 16:14:30 +00:00

Thanks for this PR :)

Rather than removing this file, could you instead move it to the .gitea directory (which doesn't yet exist), so that when we move to gitea.com if issue templates don't yet exist as a feature in Gitea then we still have this as a fallback

Thanks for this PR :) Rather than removing this file, could you instead move it to the `.gitea` directory (which doesn't yet exist), so that when we move to gitea.com if issue templates don't yet exist as a feature in Gitea then we still have this as a fallback
redstonedesigner (Migrated from github.com) reviewed 2021-07-09 16:19:52 +00:00
@ -0,0 +9,4 @@
attributes:
value: |
1. Please speak English, this is the language all maintainers can speak and write.
2. Please ask questions or configuration/deploy problems on our Discord
redstonedesigner (Migrated from github.com) commented 2021-07-09 16:19:51 +00:00

Always useful to have this information in multiple locations. It also keeps it on the page where they are submitting the form.

Always useful to have this information in multiple locations. It also keeps it on the page where they are submitting the form.
redstonedesigner (Migrated from github.com) reviewed 2021-07-09 16:21:40 +00:00
@ -0,0 +12,4 @@
2. Please ask questions or configuration/deploy problems on our Discord
server (https://discord.gg/gitea) or forum (https://discourse.gitea.io).
3. Please take a moment to check that your issue doesn't already exist.
4. Make sure it's not mentioned in the FAQ (https://docs.gitea.io/en-us/faq)
redstonedesigner (Migrated from github.com) commented 2021-07-09 16:21:40 +00:00

Again, keeps it present and current so that they can see it. It never hurts to remind them multiple times.

Again, keeps it present and current so that they can see it. It never hurts to remind them multiple times.
redstonedesigner (Migrated from github.com) reviewed 2021-07-09 16:23:31 +00:00
@ -0,0 +1,23 @@
name: Feature Request
description: Got an idea for a feature that Gitea doesn't have currently? Submit your idea here!
body:
redstonedesigner (Migrated from github.com) commented 2021-07-09 16:23:31 +00:00

We don't have much space here, but I could add a markdown system similar to the bug report to the feature template.

We don't have much space here, but I could add a markdown system similar to the bug report to the feature template.
redstonedesigner (Migrated from github.com) reviewed 2021-07-09 16:24:03 +00:00
redstonedesigner (Migrated from github.com) commented 2021-07-09 16:24:03 +00:00

I can definitely do that. I wasn't aware that there is a .gitea directory, and I will add the file accordingly.

I can definitely do that. I wasn't aware that there is a `.gitea` directory, and I will add the file accordingly.
redstonedesigner (Migrated from github.com) reviewed 2021-07-09 16:32:45 +00:00
@ -0,0 +1,23 @@
name: Feature Request
description: Got an idea for a feature that Gitea doesn't have currently? Submit your idea here!
body:
redstonedesigner (Migrated from github.com) commented 2021-07-09 16:32:45 +00:00

I've gone ahead and added a message to the top of the feature request template.

I've gone ahead and added a message to the top of the feature request template.
redstonedesigner (Migrated from github.com) reviewed 2021-07-15 09:49:16 +00:00
@ -0,0 +86,4 @@
id: screenshots
attributes:
label: Screenshots
description: If this issue involves the Web Interface, please provide a screenshot or multiple screenshots
redstonedesigner (Migrated from github.com) commented 2021-07-15 09:49:16 +00:00

If we would like to do that, I can definitely create a new form.

If we would like to do that, I can definitely create a new form.
redstonedesigner (Migrated from github.com) reviewed 2021-07-19 10:13:05 +00:00
@ -0,0 +86,4 @@
id: screenshots
attributes:
label: Screenshots
description: If this issue involves the Web Interface, please provide a screenshot or multiple screenshots
redstonedesigner (Migrated from github.com) commented 2021-07-19 10:13:05 +00:00

This has been added in the most recent commit and has also been added to the testing repository - https://github.com/redstonedesigner/gitea-issue-form-testing

This has been added in the most recent commit and has also been added to the testing repository - https://github.com/redstonedesigner/gitea-issue-form-testing
jpraet approved these changes 2021-09-12 08:47:55 +00:00
a1012112796 (Migrated from github.com) approved these changes 2021-09-14 10:59:10 +00:00
lafriks (Migrated from github.com) approved these changes 2021-09-15 17:03:36 +00:00
This repo is archived. You cannot comment on pull requests.
No Milestone
No project
No Assignees
4 Participants
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: lunny/gitea#16349
No description provided.