Skip to content

Commit

Permalink
Simplify issue/PR templates (#6325)
Browse files Browse the repository at this point in the history
* Update bug-report.yml

* Create feature-request.md

* Update pull_request_template.md

* Update feature-request.md

* Apply suggestions from code review

Co-authored-by: Ariel Shaqed (Scolnicov) <ariels@treeverse.io>

---------

Co-authored-by: Ariel Shaqed (Scolnicov) <ariels@treeverse.io>
  • Loading branch information
johnnyaug and arielshaqed authored Aug 6, 2023
1 parent d4aa572 commit 527770c
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 42 deletions.
40 changes: 17 additions & 23 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,13 @@ body:
- type: markdown
attributes:
value: |
## Hello Axolotl!
**Thank you for contributing to the lakeFS project.**
We appreciate the time you invest in filing a bug report and created this template to help make this process easier.
It's really important to have all the information and context, to ensure we can properly address your issue.
Please use the following references to fill out the bug report.
Thank you for contributing to the lakeFS project.
The following fields help us properly address your issue:
- type: textarea
id: what-happened
attributes:
label: What happened?
description: Also tell us, what did you expect to happen?
value: |
Current Behavior:
value: |
What actually happened, including error codes if applies.
Steps to Reproduce:
Expand All @@ -29,45 +24,44 @@ body:
- type: textarea
id: expected-behavior
attributes:
label: Expected Behavior
label: Expected behavior
description: What did you expect to happen?
value: |
Expected Behavior:
How you expected thing to work.
placeholder: |
Expected behavior:
validations:
required: false
- type: input
id: lakefs_version
attributes:
label: lakeFS Version
label: lakeFS version
description: What version of lakeFS are you running?
- type: input
id: deployment
attributes:
label: Deplyoment
description: lakeFS deployment type
placeholder: ex. AWS ECS, Docker or Kubernetes, helm-chart, local
label: How lakeFS is installed
description: How and where you installed lakeFS
placeholder: ex. AWS EC2, Docker or Kubernetes, locally
validations:
required: false
- type: input
id: clients
attributes:
label: Affected Clients
description: If applicable provide lakeFS client and version that was used
placeholder: ex. hadoop-lakefs 0.1.10, python lakefs-client 0.89.0
label: Affected clients
description: If applicable, provide the lakeFS client and version that was used
placeholder: Python lakeFS client 0.89.0
validations:
required: false
- type: textarea
id: logs
attributes:
label: Relevant logs output
description: Please copy and paste any relevant log output (lakeFS, clients, ecosystem). Make sure to scrub anything confidential! These will typically be near strings such as `secret`, `access` or `AKIA`
label: Relevant log output
description: Please copy and paste any relevant log output (server/client).
render: shell
- type: input
id: contact
attributes:
label: Contact Details
label: Contact details
description: How can we get in touch with you if we need more info?
placeholder: ex. email@example.com
placeholder: email@example.com
validations:
required: false
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
name: Feature request
about: Suggest an idea for lakeFS
title: ''
labels: ''
assignees: ''

---

Tell us about the feature you'd like to see in lakeFS.
Be as detailed and specific as possible to help us understand your needs better
23 changes: 4 additions & 19 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,5 @@
<!--
Hello Axolotl!
Thank you for contributing to the lakeFS project.
We appreciate the time invested in this pull request and created this template to help make this process easier.
It's really important to have all the information and context, to ensure we can properly address this PR
Please use the following references to fill out the pull request.
-->

### Linked Issue

Closes #(Insert issue number closed by this PR)

---

## Change Description

### Background
Expand All @@ -20,31 +8,28 @@ Share context and relevant information for the PR: offline discussions, consider

### Bug Fix

If this PR is a bug fix, please let us know about:

1. Problem - The reason for opening the bug
2. Root cause - Discovered root cause after investigation
3. solution - How was the bug fixed
3. Solution - How the bug was fixed

### New Feature

Description of new feature
If this PR introduces a new feature, describe it here.

### Testing Details

How were the changes tested?
Added new unit tests / integration tests

### Breaking Change?

Does this change break any existing functionality? (API, CLI, Clients)

---

## Additional info

Logs, outputs, screenshots of changes if applicable (CLI / GUI changes)

---

### Contact Details

How can we get in touch with you if we need more info? (ex. email@example.com)

0 comments on commit 527770c

Please sign in to comment.