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

Updates on github PR/Issue templates #642

Merged
merged 1 commit into from
Sep 5, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions .github/ISSUE_TEMPLATE/bug_report_template.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ body:
value: |
- **OS Platform and Distribution (e.g., Linux Ubuntu 20.0)**:
- **Python version**:
- **yarn version, if running the dev UI**:
- **Spark version, if reporting runtime issue**:
validations:
required: true
- type: textarea
Expand All @@ -50,7 +50,7 @@ body:
attributes:
label: Tracking information
description: |
Please provide the logs and erros for reproducibility.
Please provide the logs and errors for reproducibility.
validations:
required: false
- type: textarea
Expand All @@ -70,11 +70,11 @@ body:
label: What component(s) does this bug affect?
description: Please choose one or more components below.
options:
- label: "`Python Feathr Client`: This is the client users use to interact with most of our API. Mostly written in Python."
- label: "`Python Client`: This is the client users use to interact with most of our API. Mostly written in Python."
required: false
- label: "`Computation Engine`: The computation engine that execute the actual feature join and generation work. Mostly in Scala and Spark."
required: false
- label: "`Feature Registry API Layer`: The storage layer supports SQL, Purview(Atlas). The API layer is in Python(FAST API)"
- label: "`Feature Registry API`: The frontend API layer supports SQL, Purview(Atlas) as storage. The API layer is in Python(FAST API)"
required: false
- label: "`Feature Registry Web UI layer`: The Web UI for feature registry. Written in React with a few UI frameworks."
- label: "`Feature Registry Web UI`: The Web UI for feature registry. Written in React"
required: false
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/doc_improvements.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,6 @@ body:
attributes:
label: Description of proposal (what needs changing)
description: |
Provide a clear description. Why is the proposed documentation better?
Please provide a clear description. Why is the proposed documentation better?
validations:
required: true
12 changes: 6 additions & 6 deletions .github/ISSUE_TEMPLATE/feature_request_template.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: Feature Request
description: Use this template for feature requests.
labels: 'enhancement'
labels: 'feature'
title: '[FR]'

body:
Expand Down Expand Up @@ -43,21 +43,21 @@ body:
attributes:
label: Details
description: |
Give a clear description here.
Please provide a clear description here.
validations:
required: false

- type: checkboxes
id: component
attributes:
label: What component(s) does this bug affect?
label: What component(s) does this feature request affect?
description: Please choose one or more components below.
options:
- label: "`Python Feathr Client`: This is the client users use to interact with most of our API. Mostly written in Python."
- label: "`Python Client`: This is the client users use to interact with most of our API. Mostly written in Python."
required: false
- label: "`Computation Engine`: The computation engine that execute the actual feature join and generation work. Mostly in Scala and Spark."
required: false
- label: "`Feature Registry API Layer`: The storage layer supports SQL, Purview(Atlas). The API layer is in Python(FAST API)"
- label: "`Feature Registry API`: The frontend API layer supports SQL, Purview(Atlas) as storage. The API layer is in Python(FAST API)"
required: false
- label: "`Feature Registry Web UI layer`: The Web UI for feature registry. Written in React with a few UI frameworks."
- label: "`Feature Registry Web UI`: The Web UI for feature registry. Written in React"
required: false
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/non_technical_request_template.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: Non-technical Request
description: Use this template for non-technical requests
labels: ['enhancement', 'non-technical']
labels: ['non-technical']
title: '[NT]'

body:
Expand All @@ -25,6 +25,6 @@ body:
attributes:
label: Non-technical Request Proposal
description: |
Provide a clear high-level description of the request, like documentation improvements etc
Please provide a clear description of the request
validations:
required: true
8 changes: 3 additions & 5 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@
<!--
Hey! Thank you for the contribution! Please go through https://github.com/linkedin/feathr/blob/main/docs/dev_guide/pull_request_guideline.md for more information.

Describe
- What changes to make and why you are making these changes.
- How are you going to achieve your goal. Describe what testings you have done, for example, performance testing etc.
Describe what changes to make and why you are making these changes.

If this PR resolves an issue be sure to include "Resolves #XXX" to correctly link and close the issue upon merge.
-->
Expand All @@ -13,12 +11,12 @@ Resolves #XXX

## How was this PR tested?
<!--
If you're unsure about what to test, where to add tests, or how to run tests, please feel free to ask. We'd be happy to help.
Describe what testings you have done. If you're unsure about what to test, where to add tests, or how to run tests, please feel free to ask. We'd be happy to help.
-->

## Does this PR introduce any user-facing changes?
<!--
If yes, please clarify the previous behavior and the change this PR proposes - provide the console output, description and/or an example to show the behavior difference if possible.
If yes, please clarify the previous behavior and the change this PR proposes - provide UI screenshot, the console output, description and/or an example to show the behavior difference if possible.
If no, choose 'No'.
-->
- [ ] No. You can skip the rest of this section.
Expand Down