Skip to content

Commit 86d807a

Browse files
adrien-berchetadrien-berchet
authoredOct 5, 2023
Chore: Add templates for issues and pull requests (#475)
* Chore: Add templates for issues and pull requests * Fix libspatialite==5.0.1 in CI
·
0.17.10.14.2
1 parent 829567b commit 86d807a

File tree

6 files changed

+287
-1
lines changed

6 files changed

+287
-1
lines changed
 

‎.github/ISSUE_TEMPLATE/bug_report.yaml

+114
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
# docs https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
2+
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema
3+
4+
name: Create a bug report regarding GeoAlchemy 2 runtime behavior
5+
description: Errors and regression reports with complete reproducing test cases and/or stack traces.
6+
labels: [bug]
7+
title: "[Bug report] "
8+
body:
9+
- type: markdown
10+
attributes:
11+
value: "
12+
Thanks for taking the time to fill out this bug report!
13+
14+
15+
Before submitting, make sure you search in the [issue list](https://github.com/geoalchemy/geoalchemy2/issues) that a similar issue was not already reported.
16+
If it is not the case, please read the following guidelines.
17+
18+
### GUIDELINES FOR REPORTING BUGS
19+
20+
Bug reports that are not properly formulated and formatted or without enough details can be very hard for us to understand and fix.
21+
In order to ensure we can help you fixing your bug, please follow these guidelines.
22+
23+
24+
Your reports must include the following features:
25+
26+
1. **succinct description** of the problem - typically a line or two at most.
27+
28+
2. **succinct, dependency-free code** which reproduces the problem, otherwise known as a [Minimal, Complete, and Verifiable](https://stackoverflow.com/help/mcve) example.
29+
IF YOU DO NOT HAVE A COMPLETE, RUNNABLE TEST CASE WRITTEN DIRECTLY IN THE TEXTAREA BELOW, YOUR ISSUE MAY BE CLOSED.
30+
31+
3. **complete stack traces for all errors** - please avoid screenshots, use formatted text inside issues.
32+
33+
4. other relevant things as applicable: **dependencies**, **comparative performance timings** for performance issues, etc.
34+
"
35+
36+
- type: textarea
37+
attributes:
38+
label: Describe the bug
39+
description: A clear and concise description of what the bug is.
40+
validations:
41+
required: true
42+
43+
- type: input
44+
id: relevant_documentation
45+
attributes:
46+
label: Optional link from https://geoalchemy-2.readthedocs.io which documents the behavior that is expected
47+
description: "
48+
Please make sure the behavior you are seeing is definitely in contradiction to what's documented as the correct behavior.
49+
"
50+
validations:
51+
required: false
52+
53+
- type: textarea
54+
attributes:
55+
label: To Reproduce
56+
description: "
57+
Provide your [Minimal, Complete, and Verifiable](https://stackoverflow.com/help/mcve) example here."
58+
placeholder: "# Insert code here (text area already python formatted)"
59+
render: Python
60+
validations:
61+
required: true
62+
63+
- type: textarea
64+
attributes:
65+
label: Error
66+
description: "
67+
Provide the complete text of any errors received **including the complete stack trace**.
68+
If the message is a warning, run your program with the ``-Werror`` flag: ``python -Werror myprogram.py``
69+
"
70+
placeholder: "# Copy the complete stack trace and error message here (text area already formatted for Python backtrace)"
71+
render: Python traceback
72+
validations:
73+
required: true
74+
75+
- type: textarea
76+
attributes:
77+
label: Additional context
78+
description: Add any other context about the problem here.
79+
validations:
80+
required: false
81+
82+
- type: input
83+
id: package_version
84+
attributes:
85+
label: GeoAlchemy 2 Version in Use
86+
description: e.g. 1.4.42, 2.0.2, etc or commit hash
87+
validations:
88+
required: true
89+
90+
- type: input
91+
id: python_version
92+
attributes:
93+
label: Python Version
94+
description: Assumes cpython unless otherwise stated, e.g. 3.10, 3.11, pypy
95+
validations:
96+
required: true
97+
98+
- type: dropdown
99+
id: os
100+
attributes:
101+
label: Operating system
102+
description: Check all that apply
103+
multiple: true
104+
options:
105+
- Linux
106+
- MacOS
107+
- Windows
108+
- Other
109+
validations:
110+
required: true
111+
112+
- type: markdown
113+
attributes:
114+
value: "### Thanks! Have a nice day!"

‎.github/ISSUE_TEMPLATE/config.yml

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: true

‎.github/ISSUE_TEMPLATE/feature_request.yaml

+56
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# docs https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
2+
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema
3+
4+
name: Request a new use case
5+
description: Support for new features
6+
labels: [enhancement]
7+
title: "[Feature request] "
8+
body:
9+
- type: markdown
10+
attributes:
11+
value: "
12+
Thanks for taking the time to fill out this feature request!
13+
14+
15+
Before submitting, make sure the feature does not already exist in the [documentation](https://geoalchemy-2.readthedocs.io) and that you searched in the [issue list](https://github.com/geoalchemy/geoalchemy2/issues) that a similar feature request has not already been reported.
16+
If it is not the case, please read the following guidelines.
17+
18+
### GUIDELINES FOR REQUESTING HELP
19+
20+
Feature requests that are not properly formulated and formatted or without enough details can be very hard for us to understand.
21+
In order to ensure we can help you, please follow these guidelines.
22+
23+
24+
Your requests must include the following features:
25+
26+
1. **succinct description** of the feature - typically a line or two at most to describe what the new feature would do.
27+
28+
2. **succinct, dependency-free code** which shows how you would like to use this feature, otherwise known as a [Minimal, Complete, and Verifiable](https://stackoverflow.com/help/mcve) example.
29+
30+
3. Why do you need this feature? What would be the use cases?
31+
"
32+
33+
- type: textarea
34+
attributes:
35+
label: Describe the feature
36+
description: A clear and concise description of what the feature would consist in.
37+
validations:
38+
required: true
39+
40+
- type: textarea
41+
attributes:
42+
label: Example Use
43+
description: Provide a clear example of what the usage of this feature would look like.
44+
validations:
45+
required: true
46+
47+
- type: textarea
48+
attributes:
49+
label: Use cases
50+
description: Add as much information as possible about the use cases here.
51+
validations:
52+
required: true
53+
54+
- type: markdown
55+
attributes:
56+
value: "### Thanks! Have a nice day!"

‎.github/ISSUE_TEMPLATE/how_to_use.yaml

+91
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
# docs https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
2+
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema
3+
4+
name: Ask for help about GeoAlchemy 2
5+
description: Questions about GeoAlchemy 2 features.
6+
labels: [how to use]
7+
title: "[How to use] "
8+
body:
9+
- type: markdown
10+
attributes:
11+
value: "
12+
Thanks for using this package and taking the time to fill out this help request!
13+
14+
15+
Before submitting, make sure you read the [documentation](https://geoalchemy-2.readthedocs.io) carefully.
16+
If you still have a question, you should search in the [issue list](https://github.com/geoalchemy/geoalchemy2/issues) that a similar issue has not already been reported, you might find your answer there.
17+
If it is not the case, please read the following guidelines.
18+
19+
### GUIDELINES FOR REQUESTING HELP
20+
21+
Questions that are not properly formulated and formatted or without enough details can be very hard for us to understand.
22+
In order to ensure we can help you, please follow these guidelines.
23+
24+
25+
Your requests must include the following features:
26+
27+
1. **succinct description** of the problem - typically a line or two at most to describe what you want to achieve.
28+
29+
2. **succinct, dependency-free code** which shows what you tried to do, otherwise known as a [Minimal, Complete, and Verifiable Example](https://stackoverflow.com/help/mcve).
30+
31+
3. **expected results**
32+
33+
4. **complete stack traces for all errors** if you have any - please avoid screenshots, use formatted text inside issues.
34+
35+
5. other relevant things: **dependencies**, **operating system**, **comparative performance timings** for performance issues.
36+
"
37+
38+
- type: textarea
39+
attributes:
40+
label: Describe the problem
41+
description: A clear and concise description of what you want to achieve.
42+
validations:
43+
required: true
44+
45+
- type: textarea
46+
attributes:
47+
label: Show what you tried to do.
48+
description: "
49+
Provide your [Minimal, Complete, and Verifiable Example](https://stackoverflow.com/help/mcve) here."
50+
placeholder: "# Insert code here (text area already python formatted)"
51+
render: Python
52+
validations:
53+
required: true
54+
55+
- type: textarea
56+
attributes:
57+
label: Describe what you expected.
58+
description: A clear and concise description of what you which result you expected by doing this.
59+
validations:
60+
required: true
61+
62+
- type: textarea
63+
attributes:
64+
label: Error
65+
description: "
66+
If you are facing an arror, provide the complete text of any errors received **including the complete stack trace**.
67+
If the message is a warning, run your program with the ``-Werror`` flag: ``python -Werror myprogram.py``
68+
"
69+
placeholder: "# Copy the complete stack trace and error message here (text area already formatted for Python backtrace)"
70+
render: Python traceback
71+
validations:
72+
required: false
73+
74+
- type: textarea
75+
attributes:
76+
label: Additional context
77+
description: Add any other context about the problem here.
78+
validations:
79+
required: false
80+
81+
- type: input
82+
id: package_version
83+
attributes:
84+
label: GeoAlchemy 2 Version in Use
85+
description: e.g. 1.4.42, 2.0.2, etc or commit hash
86+
validations:
87+
required: true
88+
89+
- type: markdown
90+
attributes:
91+
value: "### Thanks! Have a nice day!"

‎.github/pull_request_template.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<!-- Provide a general summary of your proposed changes in the Title field above -->
2+
<!-- The title should have the following form: 'Type: Subject' with 'type' in [Build,Chore,CI,Deprecate,Docs,Feat,Fix,Perf,Refactor,Revert,Style,Test] -->
3+
4+
### Description
5+
<!-- Describe your changes in detail and the reasons of these changes -->
6+
7+
### Checklist
8+
<!-- Go over following points. Check them with an `x` if they do apply (they turn into clickable checkboxes once the PR is submitted, so no need to do everything at once). -->
9+
10+
This pull request is:
11+
12+
- [ ] A documentation / typographical error fix
13+
- Good to go, no issue or tests are needed
14+
- [ ] A short code fix
15+
- [ ] Please include: `Fixes: #<issue number>` in the description if it solves an existing issue
16+
(which must include a complete example of the issue).
17+
- [ ] Please include tests that fail with the `main` branch and pass with the provided fix.
18+
- [ ] A new feature implementation or update an existing feature
19+
- [ ] Please include: `Fixes: #<issue number>` in the description if it solves an existing issue
20+
(which must include a complete example of the feature).
21+
- [ ] Please include tests that cover every lines of the new/updated feature.
22+
- [ ] Please update the documentation to describe the new/updated feature.
23+
24+
<!-- **Have a nice day!** -->

‎.github/workflows/test_and_publish.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ jobs:
6868
create-args: >-
6969
${{ matrix.python-version.pkg_name }}
7070
libgdal
71-
libspatialite
71+
libspatialite==5.0.1
7272
pyproj
7373
condarc: |
7474
channels:

0 commit comments

Comments
 (0)
Please sign in to comment.