diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index e823b94..ed3a7d6 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -2,42 +2,57 @@ name: Report a bug description: File a bug report title: "[Bug]: " labels: ["bug"] -assignees: - - octocat body: - type: markdown attributes: value: | - Thanks for taking the time to fill out this bug report! + Thanks for taking the time to help us improve. + - type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Please search to see if an issue already exists for the bug you encountered. + options: + - label: I have searched the existing issues + required: true - type: textarea - id: what-happened attributes: - label: What happened? - description: Also tell us, what did you expect to happen? - placeholder: Tell us what you see! - value: "A bug happened!" - validations: - required: true - - type: dropdown - id: version + label: Environment + description: | + examples: + - **OS**: Ubuntu 20.04 + - **version**: 0.1.3 + - **rust**: 1.77 + value: | + - OS: + - version: + - rust: + render: markdown + - type: textarea + id: description attributes: - label: Version - description: What version of our software are you running? - options: - - 0.1.0 (Default) + label: Describe the bug + description: A clear and concise description of what the bug is. validations: required: true - type: textarea - id: logs + id: reproduce attributes: - label: Relevant log output - description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. - render: Shell + label: To Reproduce + description: Steps to reproduce the behavior. + - type: textarea + attributes: + label: Additional context + description: | + Links? References? Anything that will give us more context about the issue you are encountering! + + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. + validations: + required: false - type: checkboxes id: terms attributes: label: Code of Conduct - description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com) + description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/delta-incubator/delta-sharing-rs#coc-ov-file) options: - label: I agree to follow this project's Code of Conduct required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml index ee6508f..ef4fdb7 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yaml +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -1,37 +1,43 @@ name: Request a new feature description: File a feature request -title: "[Tool, Solution, or Feature Name]: " +title: "[Feature]: " labels: ["enhancement"] -assignees: - - octocat body: - type: markdown attributes: value: | - Thanks for taking the time to fill out this feature request! + Thanks for taking the time to help us improve! - type: textarea id: problem attributes: - label: Is your feature request related to a problem? Please describe. - description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - placeholder: Tell us what happened! - value: "A problem occured!" + label: Problem description + description: Is your feature request related to a problem or challenge? Please describe what you are trying to do. + placeholder: | + A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + (This section helps developers understand the context and *why* for this feature, in addition to the *what*) validations: - required: false + required: true - type: textarea id: solution attributes: - label: Describe the solution you'd like. - description: A clear and concise description of what you want to happen. - placeholder: Tell us what you expect! - value: "I want this feature!" + label: Solution + description: Tell us what you expect to happen. + placeholder: A clear and concise description of what you want to happen. validations: required: true + - type: textarea + id: alternatives + attributes: + label: Alternative solutions + description: Describe alternatives you've considered. + placeholder: A clear and concise description of any alternative solutions or features you've considered. + validations: + required: false - type: checkboxes id: terms attributes: label: Code of Conduct - description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com) + description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/delta-incubator/delta-sharing-rs#coc-ov-file) options: - label: I agree to follow this project's Code of Conduct required: true diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..9cb3245 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,30 @@ +### Which issue does this PR close? + + + +Closes #. + +### Rationale for this change + + + +### Changes are included in this PR + + + +### Are there any user-facing changes? + + + +