Skip to content

Commit 562d13f

Browse files
committed
add issue templates
1 parent a8b8b5f commit 562d13f

5 files changed

Lines changed: 133 additions & 1 deletion

File tree

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
name: "🐛 Bug report"
2+
description: Report something that isn’t working as intended
3+
title: "[Bug] <short title>"
4+
labels: ["bug"]
5+
assignees: ["miskler"]
6+
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
**Thanks for taking the time to report a bug!**
12+
13+
- type: checkboxes
14+
id: area
15+
attributes:
16+
label: Affected area(s)
17+
description: Check all that apply.
18+
options:
19+
- label: core
20+
- label: anti-bot
21+
- label: python interface
22+
validations:
23+
required: true
24+
25+
- type: textarea
26+
id: steps
27+
attributes:
28+
label: What did you do?
29+
description: Step-by-step commands or actions to reproduce the issue.
30+
render: plaintext
31+
validations:
32+
required: true
33+
34+
- type: textarea
35+
id: actual
36+
attributes:
37+
label: What happened?
38+
description: Paste error messages or describe the incorrect behaviour. Logs can be attached below.
39+
render: plaintext
40+
validations:
41+
required: true
42+
43+
- type: textarea
44+
id: expected
45+
attributes:
46+
label: What did you expect to happen?
47+
render: plaintext
48+
validations:
49+
required: true
50+
51+
- type: textarea
52+
id: logs
53+
attributes:
54+
label: Logs / screenshots
55+
description: Drag & drop log files or screenshots here.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
blank_issues_enabled: false
2+
3+
contact_links:
4+
- name: 📖 Read the docs
5+
url: https://miskler.github.io/jsonschema-diff/basic/quick_start/
6+
about: Start here for “how-to” questions.
7+
- name: 💬 Discord server (Discussions)
8+
url: https://discord.gg/UnJnGHNbBp
9+
about: General Q&A and community support.
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: "📚 Docs issue"
2+
description: Flag inaccurate or missing documentation
3+
title: "[Docs] <short title>"
4+
labels: ["documentation"]
5+
assignees: ["miskler"]
6+
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
**Help us keep the docs sharp!**
12+
13+
- type: input
14+
id: url
15+
attributes:
16+
label: Link to the problematic page
17+
placeholder: "https://example.com/docs/..."
18+
validations:
19+
required: true
20+
21+
- type: textarea
22+
id: problem
23+
attributes:
24+
label: What’s broken or unclear?
25+
render: markdown
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: screenshots
31+
attributes:
32+
label: Screenshots (optional)
33+
description: Drag & drop images if they help illustrate the issue.
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: "✨ Feature request"
2+
description: Suggest an idea to improve the project
3+
title: "[Feature] <short title>"
4+
labels: ["feature", "enhancement"]
5+
assignees: ["miskler"]
6+
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
**Thank you for helping us grow!**
12+
Please fill out the fields below; mock-ups/screenshots are welcome.
13+
14+
- type: input
15+
id: what
16+
attributes:
17+
label: What do you want to achieve?
18+
placeholder: "e.g. Support dark mode in the web UI"
19+
validations:
20+
required: true
21+
22+
- type: textarea
23+
id: how
24+
attributes:
25+
label: How should it look/work?
26+
description: |
27+
Describe the desired behaviour. Plain text is mandatory; you can drag-and-drop images below if helpful.
28+
render: markdown
29+
validations:
30+
required: true
31+
32+
- type: textarea
33+
id: context
34+
attributes:
35+
label: Additional context / attachments
36+
description: Drag & drop any images or diagrams here.

docs/source/conf.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,6 @@ def linkcode_resolve(domain: str, info: dict) -> Optional[str]:
213213
"search_policy": SearchPolicy(custom_patterns=['{class_name}.{method_name}.main.json']),
214214
"autodoc_ignore": [
215215
"perekrestok_api.abstraction",
216-
"perekrestok_api.PerekrestokAPI",
217216
],
218217
}
219218

0 commit comments

Comments
 (0)