Skip to content

Commit

Permalink
Add templates for issues, add autoassign (#3)
Browse files Browse the repository at this point in the history
Signed-off-by: Jakub Stejskal <[email protected]>
  • Loading branch information
Frawless authored Jul 12, 2024
1 parent 3e328fb commit 3b50ca7
Show file tree
Hide file tree
Showing 9 changed files with 152 additions and 4 deletions.
54 changes: 54 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
name: Bug report
description: Create a report to help us improve
title: '[Bug]: '
labels: ['bug', 'needs-triage']
body:
- type: markdown
attributes:
value: _Please use this only for bug reports. For questions or when you need help, you can use the [GitHub Discussions](https://github.com/skodjob/data-generator/discussions)._
- type: textarea
attributes:
label: Bug Description
description: Describe the bug
placeholder: A clear and concise description of what the bug is.
validations:
required: true
- type: textarea
attributes:
label: Expected behavior
description: What is the behavior you expected to see? Please describe.
placeholder: A clear and concise description of what you expected to happen.
validations:
required: false
- type: input
id: data-generator-version
attributes:
label: DATA-GENERATOR version
description: Data-Generator version where the bug occurred
placeholder: e.g. main, 0.1.0
validations:
required: true
- type: input
id: kubernetes-version
attributes:
label: Kubernetes version
description: Kubernetes version where the bug occurred
placeholder: e.g. Kubernetes 1.25, OpenShift 4.11
validations:
required: true
- type: textarea
attributes:
label: Logs
description: All relevant configuration and log files
placeholder: |
Attach or copy and paste the relevant logs.
validations:
required: false
- type: textarea
attributes:
label: Additional context
description: Any additional context related to the problem
placeholder: Add any other context about the problem here.
validations:
required: false
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: Questions and Discussions
url: https://github.com/skodjob/data-generator/discussions
about: Please ask and discuss questions here.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Documentation
description: Report a bug or suggest an idea for our documentation
title: '[Docs]: '
labels: ['documentation', 'needs-triage']
body:
- type: textarea
attributes:
label: Suggestion / Problem
description: Suggestion / Problem
placeholder: Describe your problem or suggestion
validations:
required: true
- type: textarea
attributes:
label: Documentation Link
description: Link(s) to the relevant documentation
placeholder: Provide link(s) to the documentation where the bug / suggestion should be applied
validations:
required: false
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
name: Feature request
description: Suggest an idea for this project
title: '[Enhancement]: '
labels: ['enhancement', 'needs-triage']
body:
- type: textarea
attributes:
label: Related problem
description: Is your feature request related to a problem? Please describe.
placeholder: A clear and concise description of what the problem is. Ex. I'm always frustrated when ...
validations:
required: false
- type: textarea
attributes:
label: Suggested solution
description: Describe the solution you'd like
placeholder: A clear and concise description of what you want to happen.
validations:
required: true
- type: textarea
attributes:
label: Alternatives
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: textarea
attributes:
label: Additional context
description: Additional context
placeholder: Add any other context or screenshots about the feature request here.
validations:
required: false
14 changes: 14 additions & 0 deletions .github/auto_assign.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Set to true to add reviewers to pull requests
addReviewers: true

# Set to true to add assignees to pull requests
addAssignees: author

# A list of reviewers to be added to pull requests (GitHub user name)
reviewers:
- kornys
- Frawless

# A number of reviewers added to the pull request
# Set 0 to add all the reviewers (default: 0)
numberOfReviewers: 0
11 changes: 11 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# 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/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file

version: 2
updates:
- package-ecosystem: "maven" # See documentation for possible values
directory: "/" # Location of package manifests
schedule:
interval: "weekly"
10 changes: 10 additions & 0 deletions .github/workflows/auto_assign.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
name: Skodjob bot
on:
pull_request:
types: [opened, ready_for_review]

jobs:
review:
runs-on: ubuntu-latest
steps:
- uses: kentaro-m/[email protected]
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributing to Test Frame
# Contributing to Data Generator

First off, thanks for taking the time to contribute! πŸŽ‰πŸ‘ The following is a set of guidelines for contributing to the Test Frame repository.
First off, thanks for taking the time to contribute! πŸŽ‰πŸ‘ The following is a set of guidelines for contributing to the Data Generator repository.

## Code of Conduct

Expand Down Expand Up @@ -49,4 +49,4 @@ Please follow the existing code style and conventions used in the project. This
- [GitHub Help](https://help.github.com/)
- [Understanding the GitHub Flow](https://guides.github.com/introduction/flow/)

Thank you for contributing to Test Frame!
Thank you for contributing to Data Generator!
2 changes: 1 addition & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ We are committed to keeping our users safe and will do our utmost to address all
- [CVE Details](https://www.cvedetails.com/)
- [National Vulnerability Database](https://nvd.nist.gov/)

Thank you for helping us keep Test Frame secure!
Thank you for helping us keep Data Generator secure!

0 comments on commit 3b50ca7

Please sign in to comment.