Skip to content

Commit

Permalink
chore(repo): Add GitHub Issue and PR templates (#48)
Browse files Browse the repository at this point in the history
Co-authored-by: Fabian Meyer <[email protected]>
  • Loading branch information
lusu007 and meyfa authored Jul 14, 2024
1 parent 1800afa commit a302ef0
Show file tree
Hide file tree
Showing 4 changed files with 97 additions and 0 deletions.
49 changes: 49 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
name: Bug report
description: Create a bug report if you found a problem with Foreman
body:
- type: markdown
attributes:
value: |
Thank you for reporting an issue. Before opening a bug report, please review our documentation.
If you cannot find a solution, kindly complete the following template with as much information as possible.
- type: input
attributes:
label: Version
description: The version of Foreman you are using.
placeholder: e.g. 1.2.3
validations:
required: true

- type: textarea
attributes:
label: Actual behavior (issue description)
description: A clear, concise and short description of the issue you are facing. Please provide textual output instead of screenshots.
validations:
required: true

- type: textarea
attributes:
label: Expected behavior
description: What should happen instead.

- type: textarea
attributes:
label: Steps to reproduce
description: A step-by-step guide for reproducing the issue.
placeholder: |
1. Installation via ...
2. Run ...
3. See error ...
validations:
required: true

- type: textarea
attributes:
label: Custom configuration
description: Any custom configuration option you have changed.

- type: textarea
attributes:
label: Additional information
description: Anything else you think we should know.
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: Feature request
description: Suggest a new feature for Foreman
body:
- type: textarea
attributes:
label: Is your feature request related to a problem?
description: A clear and concise description of what the problem is. Please describe.
placeholder: |
Ex. I'm always frustrated when [...]
validations:
required: false

- type: textarea
attributes:
label: Desired feature
description: Provide a clear and concise description of the desired outcome.
validations:
required: true

- type: textarea
attributes:
label: Considered alternatives
description: Describe any alternative solutions or features you've thought about.
validations:
required: false

- type: textarea
attributes:
label: Additional context
description: Include any additional information or screenshots relevant to the feature request.
validations:
required: false
15 changes: 15 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
## Description

<!-- Please include a summary of the change and which issue is fixed. Also, include relevant motivation and context. List any dependencies that are required for this change. -->

Fixes #(issue)

## Additional Context

<!-- Add any other context or information about the pull request here. -->

N/A

## Checklist

- [ ] The pull request title meets the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification and optionally includes the scope, for example: `feat: Add social login`

0 comments on commit a302ef0

Please sign in to comment.