docs: added GitHub template for Bug report, Feature request, added configuration for Semantic Pull Requests (influxdata#125)

bednar · web-flow · commit ff136c799052 · 2020-07-09T13:34:37.000+02:00
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,34 @@
+---
+name: Bug report
+about: Create a report to help us improve
+---
+
+<!--
+
+Thank you for reporting a bug. 
+
+* Please add a :+1: or comment on a similar existing bug report instead of opening a new one.
+    * https://github.com/influxdata/influxdb-client-python/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+is%3Aclosed+sort%3Aupdated-desc+label%3Abug+
+* Please check whether the bug can be reproduced with the latest release.
+* The fastest way to fix a bug is to open a Pull Request.
+    * https://github.com/influxdata/influxdb-client-python/pulls
+
+-->
+
+__Steps to reproduce:__
+List the minimal actions needed to reproduce the behavior.
+
+1. ...
+2. ...
+3. ...
+
+__Expected behavior:__
+Describe what you expected to happen.
+
+__Actual behavior:__
+Describe What actually happened.
+
+__Specifications:__
+ - Client Version:
+ - InfluxDB Version:
+ - Platform:
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,28 @@
+---
+name: Feature request
+about: Opening a feature request kicks off a discussion
+---
+
+<!--
+
+Thank you for suggesting an idea to improve this client. 
+
+* Please add a :+1: or comment on a similar existing feature request instead of opening a new one.
+    * 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+
+
+-->
+
+__Proposal:__
+Short summary of the feature.
+
+__Current behavior:__
+Describe what currently happens.
+
+__Desired behavior:__
+Describe what you want.
+
+__Alternatives considered:__
+Describe other solutions or features you considered.
+
+__Use case:__
+Why is this important (helps with prioritizing requests)?
diff --git a/.github/PULL_REQUEST_TEMPLATE b/.github/PULL_REQUEST_TEMPLATE
@@ -1,8 +1,16 @@
 Closes #
 
+## Proposed Changes
+
 _Briefly describe your proposed changes:_
 
+## Checklist
+
+<!-- Checkboxes below this note can be erased if not applicable to your Pull Request. -->
+
 - [ ] CHANGELOG.md updated
 - [ ] Rebased/mergeable
-- [ ] Tests pass
-- [ ] Sign [CLA](https://influxdata.com/community/cla/) (if not already signed)
+- [ ] A test has been added if appropriate
+- [ ] `pytest tests` completes successfully
+- [ ] Commit messages are in [semantic format](https://seesparkbox.com/foundry/semantic_commit_messages)
+- [ ] Sign [CLA](https://influxdata.com/community/cla/) (if not already signed)
diff --git a/.github/semantic.yml b/.github/semantic.yml
@@ -0,0 +1,3 @@
+# docs: https://github.com/probot/semantic-pull-requests#configuration
+# Always validate the PR title AND all the commits
+titleAndCommits: true

Original file line number	Diff line number	Diff 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`