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

Draft issue and PR templates. #32

Draft
wants to merge 6 commits into
base: master
Choose a base branch
from
Draft

Conversation

real-yfprojects
Copy link
Collaborator

Includes Bug Report, Bug Report Form, Feature Request and a PR template.

This is still a draft since other part of the documentation have to be finished before the templates can be completed.

Includes `Bug Report`, `Bug Report Form`, `Feature Request` and a PR template.
@real-yfprojects
Copy link
Collaborator Author

Any suggestions for enhancing the templates?

@real-yfprojects real-yfprojects linked an issue May 2, 2023 that may be closed by this pull request
4 tasks
@real-yfprojects real-yfprojects self-assigned this May 4, 2023
Comment on lines +48 to +49
- [ ] I have read the [CONTRIBUTING]() guide.
- [ ] My code follows the [code style]() of this project.
Copy link
Owner

Choose a reason for hiding this comment

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

Reminder: need to add links

real-yfprojects and others added 3 commits May 11, 2023 07:07
This configures that two contact links to the discussions and the docs will be displayed alongside the issue forms.

* .github/ISSUE_TEMPLATE/config.yml
@real-yfprojects
Copy link
Collaborator Author

I configured so called contact links that will be listed below the issue forms.

@webknjaz
Copy link

Any suggestions for enhancing the templates?

No need to duplicate Issue Forms with Issue Templates. Just use Issue Forms (yaml files).

@akaihola
Copy link
Owner

No need to duplicate Issue Forms with Issue Templates. Just use Issue Forms (yaml files).

@webknjaz does this mean that this PR can just be closed?

@webknjaz
Copy link

Why? Just don't add templates, keep the forms.

@akaihola
Copy link
Owner

Why? Just don't add templates, keep the forms.

Oops, indeed. So remove bug_report.md from the PR, right? @real-yfprojects could you do that?

@webknjaz
Copy link

Yes, though it's probably useful to have several forms for different cases. Not just bugs. But it's up to you. I just wanted to point out that weird duplicate.

* .github/ISSUE_TEMPLATE/config.yml

Co-authored-by: Antti Kaihola <[email protected]>
@real-yfprojects
Copy link
Collaborator Author

Any suggestions for enhancing the templates?

No need to duplicate Issue Forms with Issue Templates. Just use Issue Forms (yaml files).

Since issue forms are in beta still and I havened seen them used much yet, I decided to keep the option of the classic issue template which might be preferred by many people.

Copy link
Owner

@akaihola akaihola left a comment

Choose a reason for hiding this comment

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

I still see both

.github/ISSUE_TEMPLATE/bug_form.yaml

and

.github/ISSUE_TEMPLATE/bug_report.md

Aren't these the same thing both as a form and as a template, as pointed out by @webknjaz earlier?

@real-yfprojects real-yfprojects removed their assignment Apr 3, 2024
@real-yfprojects
Copy link
Collaborator Author

real-yfprojects commented Apr 3, 2024

@real-yfprojects could you do that?

I am no working on this PR or this repo in general. Anyone can pickup where I left of.

Aren't these the same thing both as a form and as a template

Yes, they are.

@webknjaz
Copy link

webknjaz commented Apr 3, 2024

Since issue forms are in beta still and I havened seen them used much yet, I decided to keep the option of the classic issue template which might be preferred by many people.

I've been using forms since before they've gone public, in a private beta. It's been a long time. They are quite stable. Here's an example: https://github.com/ansible/ansible/issues/new/choose.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Issue and PR templates
3 participants