-
Notifications
You must be signed in to change notification settings - Fork 21
Use issue templates #251
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
Merged
Merged
Use issue templates #251
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
f3053dd
Use issue templates
2bndy5 fdd4274
switch to forms instead of unrestrained markdown input
2bndy5 1165826
don't allow blank issue template
2bndy5 eaee555
self review
2bndy5 50d94fd
update templates based on tests in our test repo
2bndy5 9118e52
add blank template for maintainers
2bndy5 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| name: Report a problem | ||
| description: Create a report to let us help you | ||
| body: | ||
| - type: textarea | ||
| attributes: | ||
| label: What events trigger your workflow? | ||
| id: ci-triggers | ||
| description: >- | ||
| Please copy and paste the workflow triggers. | ||
| If you are using a resuable workflow (`workflow_dispatch` event), | ||
| then please also include the workflow triggers that the calling workflow uses. | ||
| placeholder: |- | ||
| on: | ||
| pull_request: | ||
| branches: [main, master, develop] | ||
| paths: ['**.c', '**.cpp', '**.h', '**.hpp', '**.cxx', '**.hxx', '**.cc', '**.hh', '**CMakeLists.txt', 'meson.build', '**.cmake'] | ||
| push: | ||
| branches: [main, master, develop] | ||
| paths: ['**.c', '**.cpp', '**.h', '**.hpp', '**.cxx', '**.hxx', '**.cc', '**.hh', '**CMakeLists.txt', 'meson.build', '**.cmake'] | ||
| render: yml | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: runner-os | ||
| attributes: | ||
| label: What OS does your workflow use? | ||
| description: >- | ||
| Please tell us what OS the workflow [`runs-on`](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idruns-on). | ||
| If you are using an additional [`container`](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idcontainer), | ||
| then please also include that information here. | ||
| placeholder: |- | ||
| runs-on: ubuntu-latest | ||
| container: node:18 | ||
| render: yml | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: cpp-linter-config | ||
| attributes: | ||
| label: How is cpp-linter-action configured? | ||
| description: >- | ||
| Please copy and paste the version and inputs used to run cpp-linter-action. | ||
| placeholder: |- | ||
| - uses: cpp-linter/cpp-linter-action@v2 | ||
| id: linter | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| with: | ||
| style: 'file' | ||
| tidy-checks: '' | ||
| render: yml | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: what-happened | ||
| attributes: | ||
| label: What was the unexpected behavior? | ||
| description: >- | ||
| Use this area to describe what behavior you expected and what behavior you observed. | ||
| Please be clear and concise as possible. Use screenshots if that would help. Most users | ||
| use this to paste the workflow logs. | ||
| placeholder: You can use markdown syntax here | ||
| validations: | ||
| required: true |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| # this setting will force users to use the provided issue templates | ||
| blank_issues_enabled: false | ||
| # if the templates provided don't fit the subject of the user feedback, | ||
| # here we can give links to other forms of user feedback | ||
| 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 | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| --- | ||
| name: Feature request | ||
| description: Suggest an idea for this project | ||
| body: | ||
| - type: dropdown | ||
| id: existing-feature | ||
| attributes: | ||
| label: Is your idea related to an existing feature? | ||
| description: >- | ||
| If this idea is related to an already available feature(s), then please list them here. | ||
| multiple: true | ||
| options: | ||
| - version | ||
| - thread-comments | ||
| - tidy-checks | ||
| - style | ||
| - lines-changed-only | ||
| - ignore | ||
| - tidy-ignore | ||
| - format-ignore | ||
| - files-changed-only | ||
| - file-annotations | ||
| - step-summary | ||
| - no-lgtm | ||
| - tidy-review | ||
| - format-review | ||
| - passive-reviews | ||
| - verbosity | ||
| - 'output: checks-failed' | ||
| - 'output: clang-tidy-checks-failed' | ||
| - 'output: clang-format-checks-failed' | ||
|
|
||
| - type: textarea | ||
| id: behavior | ||
| attributes: | ||
| label: Describe the behavior you would like | ||
| description: >- | ||
| Use this area to describe what behavior you desire. | ||
| Please be clear and concise as possible. Use screenshots if that would help. | ||
| placeholder: You can use markdown syntax here | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: alternative | ||
| attributes: | ||
| label: Describe alternatives you have considered | ||
| description: >- | ||
| Were you able to achieve the desired behavior in some other/inconvenient way? | ||
| placeholder: You can use markdown syntax here | ||
|
|
||
| - type: textarea | ||
| id: added-context | ||
| attributes: | ||
| label: Additional context | ||
| description: >- | ||
| If there is anything that might be special or specific to your usage, please let us know. | ||
| placeholder: You can use markdown syntax here |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| --- | ||
| name: Maintainers' note | ||
| about: For ideas related to maintaining the cpp-linter-action source code | ||
| title: '' | ||
| labels: '' | ||
| assignees: '' | ||
|
|
||
| --- | ||
|
|
||
| This issue template is intended only for maintainers of cpp-linter org. | ||
|
|
||
| Only use this issue template if your query is **not** related to a problem or feature. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
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:
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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: truewhich 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
There was a problem hiding this comment.
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.