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

Issue template form #16349

Merged
merged 27 commits into from Sep 15, 2021
Merged

Issue template form #16349

merged 27 commits into from Sep 15, 2021

Conversation

redstonedesigner
Copy link
Contributor

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 issue template has been based off of the current issue creation workflow defined in the ISSUE_TEMPLATE.md file
This commit allows for that issue template (which is a legacy method of creating an issue) to be deleted
This commit deletes the old issue template file, as it is both legacy and replaced by ISSUE_TEMPLATE/issue.yaml
Copy link
Member

@delvh delvh left a comment

Choose a reason for hiding this comment

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

Well done 👍

.github/ISSUE_TEMPLATE/issue.yaml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/issue.yaml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/issue.yaml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/issue.yaml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/issue.yaml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/issue.yaml Outdated Show resolved Hide resolved
@GiteaBot GiteaBot added the lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. label Jul 6, 2021
Removed most requirements
Updated prompt to include instruction to state whether using try.gitea.io
Added default value to Gitea version
@redstonedesigner
Copy link
Contributor Author

Thank you for the feedback @delvh - I believe I have addressed your comments in my most recent commit. The test repository has also been updated with the latest version of this template.

Please let me know if you have any further input.

@redstonedesigner
Copy link
Contributor Author

Just had a thought - Would there be any further issue types that would require more specific information or additional information?

With the new issue template system, it is possible to customise the experience for the user depending on the type of error they are experiencing. It is also possible to use labels in the templates, which would be added depending on the form that's submitted.

@delvh
Copy link
Member

delvh commented Jul 6, 2021

Yes, while that is definitely possible and should be implemented sometime, I think that's beyond the scope of this PR.
Unless of course you do want to do it now.

@redstonedesigner
Copy link
Contributor Author

If we're changing the workflow for creating issues in this PR, I feel like it might be worth making all the changes in this PR to avoid multiple PRs for a similar issue.
I'm happy to do it now, just let me know what other issue forms you would like added and I can get them configured.

@delvh
Copy link
Member

delvh commented Jul 6, 2021

Well okay, then I would first recommend a second template for Feature Requests.
This would be pretty basic and most likely only contain one or two sections: a) the description of this feature (this can be required) and b) an area to show optional screenshots (i.e. of the GitHub implementation or a proposed design)

@redstonedesigner
Copy link
Contributor Author

I've gone ahead and put the feature request form onto the testing repository as well as this PR.

Copy link
Member

@delvh delvh left a comment

Choose a reason for hiding this comment

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

👍

.github/ISSUE_TEMPLATE/issue.yaml Outdated Show resolved Hide resolved
@a1012112796 a1012112796 added the type/docs This PR mainly updates/creates documentation label Jul 6, 2021
@a1012112796
Copy link
Member

image

How to provide link to try.gitea.io ?

@redstonedesigner
Copy link
Contributor Author

image

How to provide link to try.gitea.io ?

You're prompted to include it in the Description field, which is below the Logs field.

@codecov-commenter
Copy link

codecov-commenter commented Jul 6, 2021

Codecov Report

Merging #16349 (0557cfe) into main (45ebcb0) will decrease coverage by 0.00%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##             main   #16349      +/-   ##
==========================================
- Coverage   45.22%   45.22%   -0.01%     
==========================================
  Files         766      766              
  Lines       86716    86716              
==========================================
- Hits        39217    39214       -3     
- Misses      41148    41151       +3     
  Partials     6351     6351              
Impacted Files Coverage Δ
models/gpg_key_common.go 59.67% <0.00%> (-4.84%) ⬇️
modules/queue/queue_channel.go 91.66% <0.00%> (-3.34%) ⬇️
modules/queue/workerpool.go 48.09% <0.00%> (-0.39%) ⬇️
modules/queue/queue_disk_channel.go 62.72% <0.00%> (+1.77%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 45ebcb0...0557cfe. Read the comment docs.

Co-authored-by: a1012112796 <1012112796@qq.com>
@delvh
Copy link
Member

delvh commented Jul 6, 2021

Also, it might be nice to setup the following in the config.yml:

contact_links:
  - name: Security issues
    url/mail: security@gitea.io
    about: If your issue is security related, please write a mail to security@gitea.io instead of opening an issue

Or something similar, so that the user does not even get the idea to open a public security related issue.
However, I do not know whether GitHub supports mail addresses here, or whether they get problematic. You'll have to try whether that can actually be done, or whether that is yet impossible.

@redstonedesigner
Copy link
Contributor Author

Also, it might be nice to setup the following in the config.yml:

contact_links:
  - name: Security issues
    url/mail: security@gitea.io
    about: If your issue is security related, please write a mail to security@gitea.io instead of opening an issue

Or something similar, so that the user does not even get the idea to open a public security related issue.
However, I do not know whether GitHub supports mail addresses here, or whether they get problematic. You'll have to try whether that can actually be done, or whether that is yet impossible.

I would have to use url: mailto:security@gitea.io, which I believe might be problematic in terms of rendering. I will give it a go on the testing repository and determine how it works.

@redstonedesigner
Copy link
Contributor Author

redstonedesigner commented Jul 6, 2021

It appears there's a URL parser that validates that the URL is indeed a web URL (e.g. prefixed with https://).

As a result, I don't believe that what you're suggesting is possible.

@delvh
Copy link
Member

delvh commented Jul 6, 2021

That's a pity. This approach would have been much more intuitive than hiding that information inside the bug report as a comment… Who knows, maybe one day GitHub will add this as well?

@redstonedesigner
Copy link
Contributor Author

It is less than ideal. However I'm hoping that by positioning the email address at the very top of the bug report form should get their attention.

@redstonedesigner
Copy link
Contributor Author

Does anyone have any further input on this?

@GiteaBot GiteaBot added lgtm/need 1 This PR needs approval from one additional maintainer to be merged. and removed lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. labels Sep 12, 2021
@GiteaBot GiteaBot added lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. and removed lgtm/need 1 This PR needs approval from one additional maintainer to be merged. labels Sep 14, 2021
@lafriks lafriks merged commit a959ed9 into go-gitea:main Sep 15, 2021
@redstonedesigner redstonedesigner deleted the issue-template-form branch September 16, 2021 10:25
@go-gitea go-gitea locked and limited conversation to collaborators Oct 19, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. type/docs This PR mainly updates/creates documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

9 participants