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

Use issue templates #251

Merged
merged 6 commits into from
Jun 21, 2024
Merged

Use issue templates #251

merged 6 commits into from
Jun 21, 2024

Conversation

2bndy5
Copy link
Collaborator

@2bndy5 2bndy5 commented Jun 20, 2024

This is so I don't have to keep asking the same set of questions when helping people troubleshoot or consider new features/ideas

This is so I don't have to keep asking the same set of questions when helping people troubleshoot or consider new features/ideas
@2bndy5 2bndy5 marked this pull request as draft June 20, 2024 20:49
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jun 20, 2024
@shenxianpeng shenxianpeng added enhancement New feature or request and removed documentation Improvements or additions to documentation labels Jun 21, 2024
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jun 21, 2024
@2bndy5 2bndy5 marked this pull request as ready for review June 21, 2024 04:07
@2bndy5 2bndy5 requested a review from shenxianpeng June 21, 2024 04:07
2bndy5 added 2 commits June 20, 2024 21:26
instead provide another avenue for feedback
@2bndy5
Copy link
Collaborator Author

2bndy5 commented Jun 21, 2024

I'm first testing these changes in the test repo. It is not working as expected...

@2bndy5
Copy link
Collaborator Author

2bndy5 commented Jun 21, 2024

Ok I've got it working the way I wanted. you can test it out in the test repo by opening a new issue

@shenxianpeng
Copy link
Collaborator

it might be good to add the following to .github/ISSUE_TEMPLATE/config.yml to allow us to open a black issue in case we need it.

- name: "(maintainers only) Blank issue"
    url: https://github.com/cpp-linter/cpp-linter-action/issues/new
    about: For maintainers only.

contact_links:
- name: cpp-linter discussions
url: https://github.com/orgs/cpp-linter/discussions
about: A place for feedback not specific to cpp-linter-action
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
about: A place for feedback not specific to cpp-linter-action
about: A place for feedback not specific to cpp-linter-action
- name: "(maintainers only) Blank issue"
url: https://github.com/cpp-linter/cpp-linter-action/issues/new
about: For maintainers only.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

That link will only direct you to the offerings of templates. What you want would basically change line at the beginning of this file:

blank-issues-enabled: true

We could do that provisionally. But if users end up not using the templates for reporting problems or suggesting new features, then I'll have to insist on disabling blank issues.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

We could also add a more general template for questions. That way us maintainers can "abuse" the question template like a blank issue template.

Copy link
Collaborator Author

@2bndy5 2bndy5 Jun 21, 2024

Choose a reason for hiding this comment

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

I added a blank template called "Maintainers' note". This way it should be clear that end-users should reconsider before using it to report a bug or request a feature.

Copy link
Collaborator

Choose a reason for hiding this comment

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

yes, we should not set blank-issues-enabled: true which will allow users to have permission to open a blank issue.

https://github.com/cpp-linter/cpp-linter-action/issues/new is a link that should only the maintainer have permission to open a blank issue, this is how I saw it done from pip project https://github.com/pypa/pip/issues/new/choose

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I didn't know account permission had any effect. With that knowledge, we can certainly do that.

@2bndy5 2bndy5 merged commit 5fbd8bd into main Jun 21, 2024
4 checks passed
@2bndy5 2bndy5 deleted the create-issue-templates branch June 21, 2024 18:52
2bndy5 added a commit that referenced this pull request Jun 24, 2024
2bndy5 added a commit that referenced this pull request Jun 24, 2024
@shenxianpeng shenxianpeng removed the documentation Improvements or additions to documentation label Aug 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants