Skip to content

Commit ff136c7

Browse files
authored
docs: added GitHub template for Bug report, Feature request, added configuration for Semantic Pull Requests (#125)
1 parent 5c39813 commit ff136c7

File tree

4 files changed

+75
-2
lines changed

4 files changed

+75
-2
lines changed
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
---
5+
6+
<!--
7+
8+
Thank you for reporting a bug.
9+
10+
* Please add a :+1: or comment on a similar existing bug report instead of opening a new one.
11+
* https://github.com/influxdata/influxdb-client-python/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+is%3Aclosed+sort%3Aupdated-desc+label%3Abug+
12+
* Please check whether the bug can be reproduced with the latest release.
13+
* The fastest way to fix a bug is to open a Pull Request.
14+
* https://github.com/influxdata/influxdb-client-python/pulls
15+
16+
-->
17+
18+
__Steps to reproduce:__
19+
List the minimal actions needed to reproduce the behavior.
20+
21+
1. ...
22+
2. ...
23+
3. ...
24+
25+
__Expected behavior:__
26+
Describe what you expected to happen.
27+
28+
__Actual behavior:__
29+
Describe What actually happened.
30+
31+
__Specifications:__
32+
- Client Version:
33+
- InfluxDB Version:
34+
- Platform:
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
name: Feature request
3+
about: Opening a feature request kicks off a discussion
4+
---
5+
6+
<!--
7+
8+
Thank you for suggesting an idea to improve this client.
9+
10+
* Please add a :+1: or comment on a similar existing feature request instead of opening a new one.
11+
* https://github.com/influxdata/influxdb-client-python/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+is%3Aclosed+sort%3Aupdated-desc+label%3A%22enhancement%22+
12+
13+
-->
14+
15+
__Proposal:__
16+
Short summary of the feature.
17+
18+
__Current behavior:__
19+
Describe what currently happens.
20+
21+
__Desired behavior:__
22+
Describe what you want.
23+
24+
__Alternatives considered:__
25+
Describe other solutions or features you considered.
26+
27+
__Use case:__
28+
Why is this important (helps with prioritizing requests)?

.github/PULL_REQUEST_TEMPLATE

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,16 @@
11
Closes #
22

3+
## Proposed Changes
4+
35
_Briefly describe your proposed changes:_
46

7+
## Checklist
8+
9+
<!-- Checkboxes below this note can be erased if not applicable to your Pull Request. -->
10+
511
- [ ] CHANGELOG.md updated
612
- [ ] Rebased/mergeable
7-
- [ ] Tests pass
8-
- [ ] Sign [CLA](https://influxdata.com/community/cla/) (if not already signed)
13+
- [ ] A test has been added if appropriate
14+
- [ ] `pytest tests` completes successfully
15+
- [ ] Commit messages are in [semantic format](https://seesparkbox.com/foundry/semantic_commit_messages)
16+
- [ ] Sign [CLA](https://influxdata.com/community/cla/) (if not already signed)

.github/semantic.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# docs: https://github.com/probot/semantic-pull-requests#configuration
2+
# Always validate the PR title AND all the commits
3+
titleAndCommits: true

0 commit comments

Comments
 (0)