Skip to content

Commit

Permalink
docs: YAML issue templates (new) (#389)
Browse files Browse the repository at this point in the history
  • Loading branch information
DaveSkender authored Jul 16, 2024
1 parent ff1e4ef commit b65faea
Show file tree
Hide file tree
Showing 5 changed files with 83 additions and 39 deletions.
23 changes: 0 additions & 23 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

39 changes: 39 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: Bug report
description: File a bug report.
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Thank you 💖 for taking the time report a bug in the [`stock-indicators` PyPI library](https://pypi.org/project/stock-indicators)!
> Please review known [issues](https://github.com/facioquo/stock-indicators-python/issues?q=is%3Aissue), community [discussions](https://github.com/DaveSkender/Stock.Indicators/discussions), and [Help! Results don't match TradingView!](https://github.com/DaveSkender/Stock.Indicators/discussions/801) before submitting a new bug report.
- type: textarea
id: what-happened
attributes:
label: What happened?
description: What did you expect to happen?
placeholder: Tell us what you see!
validations:
required: true
- type: textarea
id: usage
attributes:
label: Code usage
description: How did you write your code? Provide a code snippet. _This will be auto-formatted as code, so no need for \`backticks\`_. Also, consider providing your source _quotes_ as a _JSON, CSV, or Excel_ file in the "What happened?" field.
render: python
placeholder: |
// example (put your own code here)
results = indicators.get_ema(quotes, 14)
validations:
required: false
- type: textarea
id: logs
attributes:
label: Log output
description: Please copy and paste any relevant log output. _This will be auto-formatted as code, so no need for \`backticks\`_.
render: bash
validations:
required: false
- type: markdown
attributes:
value: If your request is urgent, please review our [sponsorship tiers](https://github.com/sponsors/facioquo). For contract custom development, contact [Skender Co.](https://skenderco.com)
10 changes: 0 additions & 10 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: Feature request
description: Suggest an idea for this project.
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
Thank you 💖 for taking the time to make a recommendation for the [`stock-indicators` PyPI library](https://pypi.org/project/stock-indicators)! If you have an idea that you don't want us to track in [our backlog](https://github.com/orgs/facioquo/projects/16), consider posting in our community [discussions](https://github.com/DaveSkender/Stock.Indicators/discussions).
- type: textarea
id: request
attributes:
label: the problem
description: What problem are you trying to solve? Or, what outcome do you want achieve? Why?
placeholder: I'm always frustrated when [...]
validations:
required: true
- type: textarea
id: solution
attributes:
label: an idea
description: Any suggestions for a solution? Include any alternative solutions you've considered. If requesting a new [reputable indicator](https://github.com/DaveSkender/Stock.Indicators/discussions/1024), please provide the original author's publication of its recipe.
placeholder: I'd love it if the library could [...]
validations:
required: false
- type: textarea
id: usage
attributes:
label: code example
description: Any proposed implementation syntax? _This will be auto-formatted as code, so no need for \`backticks\`_.
render: shell
placeholder: foo = awesome_new_feature(quotes, whatDaYaThink);
validations:
required: false
- type: markdown
attributes:
value: If your request is urgent, please review our [sponsorship tiers](https://github.com/sponsors/facioquo). For contract custom development, contact [Skender Co.](https://skenderco.com)
14 changes: 8 additions & 6 deletions docs/GemFile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ GEM
minitest (>= 5.1)
mutex_m
tzinfo (~> 2.0)
addressable (2.8.6)
public_suffix (>= 2.0.2, < 6.0)
addressable (2.8.7)
public_suffix (>= 2.0.2, < 7.0)
base64 (0.2.0)
bigdecimal (3.1.8)
coffee-script (2.4.1)
Expand All @@ -31,7 +31,7 @@ GEM
concurrent-ruby (1.3.3)
connection_pool (2.4.1)
cssminify2 (2.0.1)
dnsruby (1.72.1)
dnsruby (1.72.2)
simpleidn (~> 0.2.1)
drb (2.2.1)
em-websocket (0.5.3)
Expand All @@ -40,8 +40,9 @@ GEM
ethon (0.16.0)
ffi (>= 1.15.0)
execjs (2.9.1)
faraday (2.9.2)
faraday (2.10.0)
faraday-net_http (>= 2.0, < 3.2)
logger
faraday-net_http (3.1.0)
net-http
faraday-retry (2.2.1)
Expand Down Expand Up @@ -234,13 +235,14 @@ GEM
listen (3.9.0)
rb-fsevent (~> 0.10, >= 0.10.3)
rb-inotify (~> 0.9, >= 0.9.10)
logger (1.6.0)
mercenary (0.3.6)
mini_portile2 (2.8.7)
minima (2.5.1)
jekyll (>= 3.5, < 5.0)
jekyll-feed (~> 0.9)
jekyll-seo-tag (~> 2.1)
minitest (5.24.0)
minitest (5.24.1)
mutex_m (0.2.0)
net-http (0.4.1)
uri
Expand All @@ -257,7 +259,7 @@ GEM
rb-fsevent (0.11.2)
rb-inotify (0.11.1)
ffi (~> 1.0)
rexml (3.3.0)
rexml (3.3.2)
strscan
rouge (3.30.0)
rubyzip (2.3.2)
Expand Down

0 comments on commit b65faea

Please sign in to comment.