-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: added Issue and PR templates (#28)
Signed-off-by: Patrick Zheng <[email protected]>
- Loading branch information
1 parent
8710340
commit 80d3869
Showing
4 changed files
with
142 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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,60 @@ | ||
# Copyright The Notary Project Authors. | ||
# Licensed under the Apache License, Version 2.0 (the "License"); | ||
# you may not use this file except in compliance with the License. | ||
# You may obtain a copy of the License at | ||
# | ||
# http://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, software | ||
# distributed under the License is distributed on an "AS IS" BASIS, | ||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
# See the License for the specific language governing permissions and | ||
# limitations under the License. | ||
|
||
name: 🐛 Bug or Issue | ||
description: Something is not working as expected or not working at all! Report it here! | ||
labels: [bug, triage] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Thank you for taking the time to fill out this issue report. 🛑 Please check existing issues first before continuing: https://github.com/notaryproject/tspclient-go/issues | ||
- type: textarea | ||
id: verbatim | ||
validations: | ||
required: true | ||
attributes: | ||
label: "What is not working as expected?" | ||
description: "In your own words, describe what the issue is." | ||
- type: textarea | ||
id: expect | ||
validations: | ||
required: true | ||
attributes: | ||
label: "What did you expect to happen?" | ||
description: "A clear and concise description of what you expected to happen." | ||
- type: textarea | ||
id: reproduce | ||
validations: | ||
required: true | ||
attributes: | ||
label: "How can we reproduce it?" | ||
description: "Detailed steps to reproduce the behavior, code snippets are welcome." | ||
- type: textarea | ||
id: environment | ||
validations: | ||
required: true | ||
attributes: | ||
label: Describe your environment | ||
description: "OS and Golang version" | ||
- type: textarea | ||
id: version | ||
validations: | ||
required: true | ||
attributes: | ||
label: What is the version of your tspclient-go Library? | ||
description: "Check the `go.mod` file for the library version." | ||
- type: markdown | ||
attributes: | ||
value: | | ||
If you want to contribute to this project, we will be happy to guide you through the contribution process especially when you already have a good proposal or understanding of how to fix this issue. Join us at https://slack.cncf.io/ and choose #notary-project channel. |
This file contains 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,18 @@ | ||
# Copyright The Notary Project Authors. | ||
# Licensed under the Apache License, Version 2.0 (the "License"); | ||
# you may not use this file except in compliance with the License. | ||
# You may obtain a copy of the License at | ||
# | ||
# http://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, software | ||
# distributed under the License is distributed on an "AS IS" BASIS, | ||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
# See the License for the specific language governing permissions and | ||
# limitations under the License. | ||
|
||
blank_issues_enabled: false | ||
contact_links: | ||
- name: Ask a question | ||
url: https://slack.cncf.io/ | ||
about: "Join #notary-project channel on CNCF Slack" |
This file contains 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,53 @@ | ||
# Copyright The Notary Project Authors. | ||
# Licensed under the Apache License, Version 2.0 (the "License"); | ||
# you may not use this file except in compliance with the License. | ||
# You may obtain a copy of the License at | ||
# | ||
# http://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, software | ||
# distributed under the License is distributed on an "AS IS" BASIS, | ||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
# See the License for the specific language governing permissions and | ||
# limitations under the License. | ||
|
||
name: 🚀 Feature Request | ||
description: Suggest an idea for this project. | ||
labels: [enhancement, triage] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Thank you for taking the time to suggest a useful feature for the project! | ||
- type: textarea | ||
id: problem | ||
validations: | ||
required: true | ||
attributes: | ||
label: "Is your feature request related to a problem?" | ||
description: "A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]" | ||
- type: textarea | ||
id: solution | ||
validations: | ||
required: true | ||
attributes: | ||
label: "What solution do you propose?" | ||
description: "A clear and concise description of what you want to happen." | ||
- type: textarea | ||
id: alternatives | ||
validations: | ||
required: true | ||
attributes: | ||
label: "What alternatives have you considered?" | ||
description: "A clear and concise description of any alternative solutions or features you've considered." | ||
- type: textarea | ||
id: context | ||
validations: | ||
required: false | ||
attributes: | ||
label: "Any additional context?" | ||
description: "Add any other context or screenshots about the feature request here." | ||
- type: markdown | ||
attributes: | ||
value: | | ||
If you want to contribute to this project, we will be happy to guide you through the contribution process especially when you already have a good proposal or understanding of how to improve the functionality. Join us at https://slack.cncf.io/ and choose #notary-project channel. |
This file contains 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,11 @@ | ||
**What this PR does / why we need it**: | ||
|
||
**Which issue(s) this PR resolves** *(optional, in `resolves #<issue number>(, resolves #<issue_number>, ...)` format, will close the issue(s) when PR gets merged)*: | ||
Resolves # | ||
|
||
**Please check the following list**: | ||
- [ ] Does the affected code have corresponding tests, e.g. unit test? | ||
- [ ] Does this introduce breaking changes that would require an announcement or bumping the major version? | ||
- [ ] Do all new files have an appropriate license header? | ||
|
||
<!-- If this is a security issue, please do not discuss on GitHub. Please report any suspected or confirmed security issues directly to https://github.com/notaryproject/tspclient-go/blob/main/CODEOWNERS. --> |