Skip to content

Commit ba7a067

Browse files
committed
Fix wrong documentation link in readme
Add github Issue Templates
1 parent 2b70c4a commit ba7a067

4 files changed

Lines changed: 57 additions & 2 deletions

File tree

.github/ISSUE_TEMPLATE.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
<!---
2+
Thanks for filing an issue 😄 ! Before you submit, please read the following:
3+
4+
Check the other issue templates if you are trying to submit a bug report, feature request, or question
5+
Search open/closed issues before submitting since someone might have asked the same thing before!
6+
-->
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
name: 🐛 Bug Report
3+
about: If something isn't working as expected 🤔.
4+
5+
---
6+
## Bug Report
7+
8+
**Current Behavior**
9+
A clear and concise description of the behavior.
10+
11+
**Input Code**
12+
- REPL or Repo link if applicable:
13+
14+
```python
15+
your = "code" + "here"
16+
```
17+
18+
**Expected behavior/code**
19+
A clear and concise description of what you expected to happen (or code).
20+
21+
**Environment**
22+
- Python Version: [e.g. v2.6, v2.7, v3.0]
23+
- Hcloud-Python Version: [e.g. v0.1, v1.0]
24+
25+
**Possible Solution**
26+
<!--- Only if you have suggestions on a fix for the bug -->
27+
28+
**Additional context/Screenshots**
29+
Add any other context about the problem here. If applicable, add screenshots to help explain.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: 🚀 Feature Request
3+
about: I have a suggestion (and may want to implement it 🙂)!
4+
5+
---
6+
7+
## Feature Request
8+
9+
**Is your feature request related to a problem? Please describe.**
10+
A clear and concise description of what the problem is. Ex. I have an issue when [...]
11+
12+
**Describe the solution you'd like**
13+
A clear and concise description of what you want to happen. Add any considered drawbacks.
14+
15+
**Describe alternatives you've considered**
16+
A clear and concise description of any alternative solutions or features you've considered.
17+
18+
**Teachability, Documentation, Adoption, Migration Strategy**
19+
If you can, explain how users will be able to use this and possibly write out a version the docs.
20+
Maybe a screenshot or design?

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Official Hetzner Cloud python library
66

77

88
* Free software: MIT license
9-
* Documentation: https://hcloud.readthedocs.io.
9+
* Documentation: https://hcloud-python.readthedocs.io.
1010
* API Reference: https://docs.hetzner.cloud.
1111

1212

@@ -37,7 +37,7 @@ After the documentation has been created, click on `Usage` section
3737

3838
Or open `docs/usage.rst`
3939

40-
You can find some examples under `examples/`.
40+
You can find some more examples under `examples/`.
4141

4242

4343
Style Guide

0 commit comments

Comments
 (0)