Skip to content

Commit b63f0f2

Browse files
jams2claude
andcommitted
chore: add GitHub PR and issue templates
Add a pull request template and YAML issue forms (bug report, feature request, plus a config routing questions to Discussions), following the conventions used across torchbox/wagtail repositories. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 0b10220 commit b63f0f2

4 files changed

Lines changed: 162 additions & 0 deletions

File tree

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
name: 🐞 Bug report
2+
description: Found a bug? Let us know so we can fix it 👍
3+
labels: ['bug']
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for taking the time to fill out this bug report!
9+
10+
Before submitting, please search the [existing issues](https://github.com/torchbox/wagtail-grapple/issues) to check it hasn't already been reported.
11+
12+
- type: textarea
13+
id: summary
14+
attributes:
15+
label: Issue summary
16+
description: A clear and concise summary of the bug.
17+
placeholder: Tell us what you see!
18+
validations:
19+
required: true
20+
21+
- type: textarea
22+
id: steps
23+
attributes:
24+
label: Steps to reproduce
25+
description: Detailed steps to reproduce the behaviour. Where possible, include the relevant model / `graphql_fields` definitions and the GraphQL query.
26+
value: |
27+
1. ...
28+
2. ...
29+
3. ...
30+
validations:
31+
required: true
32+
33+
- type: textarea
34+
id: expected
35+
attributes:
36+
label: What did you expect to happen?
37+
description: Tell us what you expected, and why you consider the current behaviour a bug.
38+
validations:
39+
required: false
40+
41+
- type: input
42+
id: grapple-version
43+
attributes:
44+
label: wagtail-grapple version
45+
description: Run `pip show wagtail-grapple | grep Version`.
46+
validations:
47+
required: true
48+
49+
- type: input
50+
id: wagtail-version
51+
attributes:
52+
label: Wagtail version
53+
description: Run `pip show wagtail | grep Version`.
54+
validations:
55+
required: true
56+
57+
- type: input
58+
id: django-version
59+
attributes:
60+
label: Django version
61+
description: Run `pip show django | grep Version`.
62+
validations:
63+
required: true
64+
65+
- type: input
66+
id: python-version
67+
attributes:
68+
label: Python version
69+
description: Run `python --version`.
70+
validations:
71+
required: true
72+
73+
- type: textarea
74+
id: additional
75+
attributes:
76+
label: Additional information
77+
description: Any other relevant information — `graphene` / `graphene-django` versions, tracebacks, screenshots, etc.
78+
validations:
79+
required: false

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: ❓ Question or discussion
4+
url: https://github.com/torchbox/wagtail-grapple/discussions
5+
about: Use GitHub Discussions to ask questions or get help with Wagtail Grapple.
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: 🚀 Feature request
2+
description: Suggest an idea or improvement for Wagtail Grapple
3+
labels: ['type: Enhancement']
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for suggesting an improvement!
9+
10+
Please search the [existing issues](https://github.com/torchbox/wagtail-grapple/issues) first to avoid duplicates.
11+
12+
- type: textarea
13+
id: problem
14+
attributes:
15+
label: Is your proposal related to a problem?
16+
description: A clear and concise description of the problem. For example, "I'm always frustrated when..."
17+
validations:
18+
required: false
19+
20+
- type: textarea
21+
id: solution
22+
attributes:
23+
label: Describe the solution you'd like
24+
description: A clear and concise description of what you want to happen.
25+
validations:
26+
required: true
27+
28+
- type: textarea
29+
id: alternatives
30+
attributes:
31+
label: Describe alternatives you've considered
32+
description: Any alternative solutions or features you've considered.
33+
validations:
34+
required: false
35+
36+
- type: textarea
37+
id: context
38+
attributes:
39+
label: Additional context
40+
description: Anything else to add? Link related issues here if you haven't already.
41+
validations:
42+
required: false

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
<!-- Thanks for contributing to Wagtail Grapple! -->
2+
3+
## Description
4+
5+
<!--
6+
Describe what this pull request changes and why, with enough detail for a
7+
reviewer to verify your work. Pull requests without an adequate description
8+
may not be reviewed until one is added.
9+
-->
10+
11+
Fixes #<!-- issue number, if applicable -->
12+
13+
### AI usage
14+
15+
<!-- Please give details of any AI assistance used for this PR — including for
16+
writing this description — or "None" if no AI has been used. -->
17+
18+
## Checklist
19+
20+
- [ ] **I have added a `CHANGELOG.md` entry** under the `## Unreleased`
21+
heading, in the relevant `Added` / `Changed` / `Fixed` / `Removed` section
22+
- [ ] I have performed a self-review of my own code
23+
- [ ] I have added or updated tests covering my change (or explained why not)
24+
- [ ] New and existing tests pass locally (`python manage.py test` from
25+
`tests/`, against both SQLite and Postgres where relevant)
26+
- [ ] Linting and pre-commit checks pass (`pre-commit run --all-files`)
27+
- [ ] I have updated the documentation in `docs/` where applicable
28+
29+
<!--
30+
CHANGELOG entry format (see existing entries in CHANGELOG.md):
31+
32+
- Short description of the change ([#PR](https://github.com/torchbox/wagtail-grapple/pull/PR)) @your-username
33+
34+
Add an "## Unreleased" heading with the appropriate subsection if one is not
35+
already present.
36+
-->

0 commit comments

Comments
 (0)