Skip to content

Commit d8c2f5d

Browse files
martin-georgievmartin-georgiev
authored
chore: add templates for contributing and reporting issues (#481)
1 parent 425f962 commit d8c2f5d

File tree

5 files changed

+654
-0
lines changed

5 files changed

+654
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 197 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,197 @@
1+
name: Bug Report
2+
description: Report a bug or unexpected behavior in postgresql-for-doctrine
3+
title: "[Bug]: "
4+
labels: ["bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to report a bug! Please fill out the form below to help us understand and reproduce the issue.
10+
11+
- type: textarea
12+
id: description
13+
attributes:
14+
label: Bug Description
15+
description: A clear and concise description of what the bug is.
16+
placeholder: Describe the bug you encountered...
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: expected
22+
attributes:
23+
label: Expected Behavior
24+
description: What did you expect to happen?
25+
placeholder: Describe what you expected to happen...
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: actual
31+
attributes:
32+
label: Actual Behavior
33+
description: What actually happened?
34+
placeholder: Describe what actually happened...
35+
validations:
36+
required: true
37+
38+
- type: textarea
39+
id: reproduction
40+
attributes:
41+
label: Steps to Reproduce
42+
description: Provide detailed steps to reproduce the issue.
43+
placeholder: |
44+
1. Configure Doctrine with...
45+
2. Create an entity with...
46+
3. Execute query...
47+
4. See error...
48+
validations:
49+
required: true
50+
51+
- type: textarea
52+
id: code-sample
53+
attributes:
54+
label: Code Sample
55+
description: Provide a minimal code sample that reproduces the issue.
56+
placeholder: |
57+
```php
58+
// Your code here
59+
```
60+
render: php
61+
validations:
62+
required: false
63+
64+
- type: textarea
65+
id: error-message
66+
attributes:
67+
label: Error Message / Stack Trace
68+
description: If applicable, provide the complete error message and stack trace.
69+
placeholder: |
70+
Paste the error message and stack trace here...
71+
render: shell
72+
validations:
73+
required: false
74+
75+
- type: dropdown
76+
id: component
77+
attributes:
78+
label: Component
79+
description: Which component is affected?
80+
options:
81+
- DBAL Types (Array, JSON, Network, Geometric, Range, etc.)
82+
- DQL Functions
83+
- DQL Operators
84+
- Value Objects (Range, Point, etc.)
85+
- Integration (Symfony, Laravel, Doctrine)
86+
- Documentation
87+
- Other
88+
validations:
89+
required: true
90+
91+
- type: input
92+
id: specific-type-function
93+
attributes:
94+
label: Specific Type/Function/Operator
95+
description: If applicable, which specific type, function, or operator is affected?
96+
placeholder: "e.g., jsonb, int4range, JSON_GET_FIELD, ST_Distance, etc."
97+
validations:
98+
required: false
99+
100+
- type: input
101+
id: package-version
102+
attributes:
103+
label: Package Version
104+
description: Which version of postgresql-for-doctrine are you using?
105+
placeholder: "e.g., 3.0.0, 2.5.1, etc."
106+
validations:
107+
required: true
108+
109+
- type: input
110+
id: php-version
111+
attributes:
112+
label: PHP Version
113+
description: Which PHP version are you using?
114+
placeholder: "e.g., 8.1, 8.2, 8.3, 8.4, 8.5"
115+
validations:
116+
required: true
117+
118+
- type: input
119+
id: doctrine-dbal-version
120+
attributes:
121+
label: Doctrine DBAL Version
122+
description: Which Doctrine DBAL version are you using?
123+
placeholder: "e.g., 3.0, 3.5, 4.0, etc."
124+
validations:
125+
required: true
126+
127+
- type: input
128+
id: doctrine-orm-version
129+
attributes:
130+
label: Doctrine ORM Version
131+
description: Which Doctrine ORM version are you using (if applicable)?
132+
placeholder: "e.g., 2.14, 2.18, 3.0, etc."
133+
validations:
134+
required: false
135+
136+
- type: input
137+
id: postgresql-version
138+
attributes:
139+
label: PostgreSQL Version
140+
description: Which PostgreSQL version are you using?
141+
placeholder: "e.g., 14.5, 15.2, 16.0, 17.0, 18.0, etc."
142+
validations:
143+
required: true
144+
145+
- type: input
146+
id: postgis-version
147+
attributes:
148+
label: PostGIS Version
149+
description: Which PostGIS version are you using (if applicable for spatial types/functions)?
150+
placeholder: "e.g., 3.4, 3.5, 3.6, etc."
151+
validations:
152+
required: false
153+
154+
- type: dropdown
155+
id: framework
156+
attributes:
157+
label: Framework
158+
description: Are you using a framework?
159+
options:
160+
- None (Plain Doctrine)
161+
- Symfony
162+
- Laravel
163+
- Other
164+
validations:
165+
required: false
166+
167+
- type: input
168+
id: framework-version
169+
attributes:
170+
label: Framework Version
171+
description: If using a framework, which version?
172+
placeholder: "e.g., Symfony 6.4, Laravel 10.x, etc."
173+
validations:
174+
required: false
175+
176+
- type: textarea
177+
id: additional-context
178+
attributes:
179+
label: Additional Context
180+
description: Add any other context about the problem here (configuration files, environment details, etc.).
181+
placeholder: Any additional information that might help...
182+
validations:
183+
required: false
184+
185+
- type: checkboxes
186+
id: checklist
187+
attributes:
188+
label: Checklist
189+
description: Please confirm the following
190+
options:
191+
- label: I have searched existing issues to ensure this bug hasn't been reported before
192+
required: true
193+
- label: I have provided all the required version information
194+
required: true
195+
- label: I have included steps to reproduce the issue
196+
required: true
197+

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 📖 Documentation
4+
url: https://github.com/martin-georgiev/postgresql-for-doctrine/tree/main/docs
5+
about: Read the comprehensive documentation for types, functions, and integration guides
6+
- name: 💬 GitHub Discussions
7+
url: https://github.com/martin-georgiev/postgresql-for-doctrine/discussions
8+
about: Ask questions, share ideas, and discuss with the community
9+
- name: 🤝 Contributing Guide
10+
url: https://github.com/martin-georgiev/postgresql-for-doctrine/blob/main/docs/CONTRIBUTING.md
11+
about: Learn how to contribute to the project
12+
- name: 💖 Sponsor the Project
13+
url: https://github.com/sponsors/martin-georgiev
14+
about: Support the development and maintenance of this project
15+

‎.github/ISSUE_TEMPLATE/documentation.yml‎

Lines changed: 140 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
1+
name: Documentation Issue
2+
description: Report an issue with documentation or suggest improvements
3+
title: "[Docs]: "
4+
labels: ["documentation"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for helping improve our documentation! Please fill out the form below.
10+
11+
- type: dropdown
12+
id: issue-type
13+
attributes:
14+
label: Documentation Issue Type
15+
description: What type of documentation issue is this?
16+
options:
17+
- Missing Documentation
18+
- Incorrect/Outdated Information
19+
- Unclear/Confusing Explanation
20+
- Broken Link
21+
- Typo/Grammar
22+
- Missing Example
23+
- Improvement Suggestion
24+
- Other
25+
validations:
26+
required: true
27+
28+
- type: dropdown
29+
id: affected-doc
30+
attributes:
31+
label: Affected Documentation
32+
description: Which documentation is affected?
33+
options:
34+
- README.md
35+
- AVAILABLE-TYPES.md
36+
- RANGE-TYPES.md
37+
- AVAILABLE-FUNCTIONS-AND-OPERATORS.md
38+
- ARRAY-AND-JSON-FUNCTIONS.md
39+
- SPATIAL-FUNCTIONS-AND-OPERATORS.md
40+
- TEXT-AND-PATTERN-FUNCTIONS.md
41+
- DATE-AND-RANGE-FUNCTIONS.md
42+
- MATHEMATICAL-FUNCTIONS.md
43+
- SPATIAL-TYPES.md
44+
- GEOMETRY-ARRAYS.md
45+
- LTREE-TYPE.md
46+
- USE-CASES-AND-EXAMPLES.md
47+
- INTEGRATING-WITH-SYMFONY.md
48+
- INTEGRATING-WITH-LARAVEL.md
49+
- INTEGRATING-WITH-DOCTRINE.md
50+
- CONTRIBUTING.md
51+
- UPGRADE.md
52+
- Code Comments/PHPDoc
53+
- Other
54+
validations:
55+
required: true
56+
57+
- type: input
58+
id: doc-location
59+
attributes:
60+
label: Specific Location
61+
description: If applicable, provide the specific section, heading, or line number.
62+
placeholder: "e.g., 'Quick Start section', 'Line 42', 'Range Types - Creating Ranges', etc."
63+
validations:
64+
required: false
65+
66+
- type: textarea
67+
id: current-content
68+
attributes:
69+
label: Current Content
70+
description: What does the documentation currently say? (copy/paste the relevant section)
71+
placeholder: Paste the current documentation content here...
72+
validations:
73+
required: false
74+
75+
- type: textarea
76+
id: issue-description
77+
attributes:
78+
label: Issue Description
79+
description: Describe the problem with the current documentation.
80+
placeholder: |
81+
What's wrong or missing?
82+
Why is it confusing or incorrect?
83+
validations:
84+
required: true
85+
86+
- type: textarea
87+
id: suggested-improvement
88+
attributes:
89+
label: Suggested Improvement
90+
description: How should the documentation be improved?
91+
placeholder: |
92+
Describe what should be added, changed, or clarified...
93+
94+
If you have specific wording suggestions, include them here.
95+
validations:
96+
required: true
97+
98+
- type: textarea
99+
id: example-code
100+
attributes:
101+
label: Example Code (if applicable)
102+
description: If suggesting a code example, provide it here.
103+
placeholder: |
104+
```php
105+
// Your suggested example code
106+
```
107+
render: php
108+
validations:
109+
required: false
110+
111+
- type: textarea
112+
id: additional-context
113+
attributes:
114+
label: Additional Context
115+
description: Add any other context, screenshots, or references.
116+
placeholder: Any additional information...
117+
validations:
118+
required: false
119+
120+
- type: dropdown
121+
id: willing-to-contribute
122+
attributes:
123+
label: Contribution
124+
description: Would you be willing to submit a pull request to fix this documentation issue?
125+
options:
126+
- "Yes, I can submit a PR"
127+
- "Yes, with guidance"
128+
- "No"
129+
validations:
130+
required: false
131+
132+
- type: checkboxes
133+
id: checklist
134+
attributes:
135+
label: Checklist
136+
description: Please confirm the following
137+
options:
138+
- label: I have checked that this documentation issue hasn't been reported before
139+
required: true
140+

0 commit comments

Comments
 (0)