Skip to content

Commit

Permalink
Add github issue templates, dependabot config and PR template (#3)
Browse files Browse the repository at this point in the history
  • Loading branch information
dhirajsb authored Nov 6, 2023
1 parent b8b98dd commit 06a2caa
Show file tree
Hide file tree
Showing 6 changed files with 151 additions and 0 deletions.
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: 'bug'
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Do this '...'
2. Do that '....'
3. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Additional context**
Add any other context about the problem here.
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/chore.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
name: Chore issue template
about: General purpose issues related to chores, project management, etc.
title: ''
labels: 'chore'
assignees: ''

---
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: 'feature'
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
64 changes: 64 additions & 0 deletions .github/ISSUE_TEMPLATE/tracker.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
name: (Internal) Tracker Template
description: Intended to help with a template for tracking larger grouped items.
title: "[Tracker]: "
labels: ["tracker"]
body:
- type: textarea
id: description
attributes:
label: Description
description: A introductory description of the larger task
validations:
required:
true
- type: input
id: branch
attributes:
label: Target Branch
description: What is the feature branch to contain this effort? If not known at this time, replace with `TBD`
placeholder: f/
validations:
required: true
- type: textarea
id: requirements
attributes:
label: Requirements
description: A series of requirements to consider this tracker complete.
placeholder: |
* P0: Show something
* P2: Allow users to change permissions
validations:
required: true
- type: textarea
id: ux-issues
attributes:
label: Itemized UX Issues
description: |
List the tickets that UX will work on.
Tip: Using a bullet list will help display links to other tickets by unraveling the name and status of that ticket.
placeholder: |
* #1234
* Design mocks - Ticket TBD
validations:
required: true
- type: textarea
id: dev-issues
attributes:
label: Itemized Dev Issues
description: |
List the tickets that Development will work on. If unknown at this time, add `TBD`
Tip: Using a bullet list will help display links to other tickets by unraveling the name and status of that ticket.
placeholder: |
* #1234
* Implement Table Page - Ticket TBD
validations:
required: true
- type: textarea
id: artifacts
attributes:
label: Related artifacts
description: Any additional artifacts that will help with the tracker goals
validations:
required: false
19 changes: 19 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# To get started with Dependabot version updates, you'll need to specify which
# package ecosystems to update and where the package manifests are located.
# Please see the documentation for all configuration options:
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates

version: 2
updates:
- package-ecosystem: "gomod"
directory: "/"
schedule:
interval: "weekly"
- package-ecosystem: "docker"
directory: "/"
schedule:
interval: "weekly"
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "weekly"
17 changes: 17 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<!--- Provide a general summary of your changes in the Title above -->

## Description
<!--- Describe your changes in detail -->

## How Has This Been Tested?
<!--- Please describe in detail how you tested your changes. -->
<!--- Include details of your testing environment, and the tests you ran to -->
<!--- see how your change affects other areas of the code, etc. -->

## Merge criteria:
<!--- This PR will be merged by any repository approver when it meets all the points in the checklist -->
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->

- [ ] The commits and have meaningful messages; the author will squash them [after approval](https://github.com/opendatahub-io/opendatahub-community/blob/main/contributor-cheatsheet.md#:~:text=Usually%20this%20is%20done%20in%20last%20phase%20of%20a%20PR%20revision) or will ask to merge with squash.
- [ ] Testing instructions have been added in the PR body (for PRs involving changes that are not immediately obvious).
- [ ] The developer has manually tested the changes and verified that the changes work

0 comments on commit 06a2caa

Please sign in to comment.