Skip to content

Commit 9063581

Browse files
authored
Workflows and templates (#39)
1 parent 6c2d936 commit 9063581

File tree

5 files changed

+139
-0
lines changed

5 files changed

+139
-0
lines changed

.github/ISSUE_TEMPLATE/bug.yml

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: Behavior Bug
2+
description: Report issues with invalid dungeon generation or other behavior bugs
3+
title: "[Bug]: "
4+
labels: [ "type: bug" ]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for reporting a bug!
10+
Please fill out the information below to help us understand the issue.
11+
- type: markdown
12+
attributes:
13+
value: |
14+
Before filling the form fields, please consider the following:
15+
- Search for existing issues in the [issue tracker](https://github.com/Joltras/Dungeon-Python/issues)
16+
- type: textarea
17+
attributes:
18+
label: Describe the bug
19+
description: |
20+
A clear and concise description of what the bug is.
21+
If you have a screenshot of the bug, please attach it below.
22+
validations:
23+
required: true
24+
- type: textarea
25+
attributes:
26+
label: Steps to reproduce the bug
27+
description: Tell us exactly how to reproduce the bug you are experiencing
28+
placeholder: |
29+
1. ...
30+
2. ...
31+
3. ...
32+
validations:
33+
required: true

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: General discussions
4+
url: https://github.com/Joltras/Dungeon-Python/discussions
5+
about: If you have any questions or problems, please use the discussions section
6+
emoji:
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: Feature Request
2+
description: Suggest an idea for this project
3+
title: "[Feature Request]: "
4+
labels: ["type: feature" ]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for filling out a feature request! Please be as detailed as possible so that we may consider and review the request easier.
10+
We ask that you search all the issues to avoid a duplicate feature request. If one exists, please reply if you have anything to add.
11+
12+
- type: textarea
13+
attributes:
14+
label: Is your feature request related to a problem?
15+
description: Please give some context for this request. Why do you want it added?
16+
validations:
17+
required: true
18+
19+
- type: textarea
20+
attributes:
21+
label: Describe the solution you'd like.
22+
description: A clear and concise description of what you want.
23+
validations:
24+
required: true
25+
26+
- type: textarea
27+
attributes:
28+
label: Describe alternatives you've considered.
29+
description: List any alternatives you might have tried to get the feature you want.
30+
validations:
31+
required: true
32+
33+
- type: textarea
34+
attributes:
35+
label: Other
36+
description: Add any other context or screenshots about the feature request below.
37+
validations:
38+
required: false
39+
40+
- type: markdown
41+
attributes:
42+
value: |
43+
Before submitting this feature request, please search our issue tracker to ensure your feature has not
44+
already been requested.

.github/pull_request_template.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
<!--
2+
MIT License
3+
4+
Copyright (c) 2022 Marketing Pipeline
5+
6+
Permission is hereby granted, free of charge, to any person obtaining a copy
7+
of this software and associated documentation files (the "Software"), to deal
8+
in the Software without restriction, including without limitation the rights
9+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10+
copies of the Software, and to permit persons to whom the Software is
11+
furnished to do so, subject to the following conditions:
12+
13+
The above copyright notice and this permission notice shall be included in all
14+
copies or substantial portions of the Software.
15+
16+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22+
SOFTWARE.
23+
-->
24+
25+
## Proposed changes
26+
27+
Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request.
28+
If it fixes a bug or resolves a feature request, be sure to link to that issue.
29+
30+
## Types of changes
31+
32+
What types of changes does your code introduce to this project?
33+
_Put an `x` in the boxes that apply_
34+
35+
- [ ] Bugfix (non-breaking change which fixes an issue)
36+
- [ ] New feature (non-breaking change which adds functionality)
37+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
38+
- [ ] Documentation Update (if none of the other choices apply)
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Thanks paper: https://github.com/papermc/paper/blob/master/.github/workflows/close_invalid_prs.yml
2+
name: Close invalid PRs
3+
4+
on:
5+
pull_request_target:
6+
types: [ opened ]
7+
8+
jobs:
9+
run:
10+
if: ${{ github.repository != github.event.pull_request.head.repo.full_name && github.head_ref == 'master' }}
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: superbrothers/close-pull-request@v3
14+
id: "master_branch"
15+
if: github.head_ref == 'master'
16+
with:
17+
comment: |
18+
Hi there! :wave: This PR is targeting the `master` branch, which is not allowed. Please target the `develop` branch instead. Thanks!

0 commit comments

Comments
 (0)