Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(gh-templates): add pr and issue templates [skip ci] #121

Merged
merged 4 commits into from
Apr 9, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: Bug Report
about: Create a report to help the library improve
labels: bug
---

# Bug Report

## Describe the bug
<!-- Describe the bug here -->

## Minimal Reproduction
<!-- like `await yahooFinance.quote('AAPL')` or maybe a link to a repo -->

## Environment
Browser or Node: <!-- Please state either `browser` or `node` here -->
Node version (if applicable):
Npm version:
Browser verion (if applicable):
Library version (e.g. `1.10.1`):

## Additional Context
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE/docs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
name: Docs Improvement
about: Suggest an improvement to the docs or README.md
labels: documentation
---

# Docs Improvment

**:exclamation: THIS IS NOT FOR TYPOS!!! PLEASE JUST FILE A PR FOR THAT! THIS IS FOR SUBSTANTIAL IMPROVEMENTS *ONLY*!**

## Suggested Improvement
<!-- E.g., add a section on this module -->

## Reason For Suggestion (if not related to a module)
<!-- Add the reason for suggestion, e.g., it would be helpful to add a section on ... so people could easily ... -->
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: Feature Request
about: Suggest an idea or feature
labels: enhancement
---

# Feature Request

## Wanted Feature
<!-- State the feature you want over here -->

## Use Cases
<!-- State the use cases of your feature, have at least 1-2 good use cases -->
-
-
-

## Potential Example Usage
This feature *could* be used in the following way:
```ts
// something here, please fill this out
```

7 changes: 7 additions & 0 deletions .github/ISSUE_TEMPLATE/meta.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
name: Meta Issue
about: Plans, roadmaps, and other meta issues
labels: meta
---

<!-- This is intentionally empty since ther are a variety of meta issues, and each one will differ -->
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/new-module.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
name: New Module Request
about: Suggest a new module
labels: enhancement, new module
---

# Feature Request

## Wanted Module
<!-- State the module you want over here, e.g., news feed -->

## Endpoint (if you found one)
<!-- please put the *actual* endpoint here, not this dummy text -->
`https://...`

### Query Params
| Name | Type | Required |
| ---- | ---- | -------- |
| | | |

## Potential Example Usage
This module *could* be used in the following way:
```ts
// something here, please fill this out
```

30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/validation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
name: Validation Error
about: Something went wrong with validation
labels: bug, validation
---

# Validation Error

## Minimal Reproduction
<!-- like `await yahooFinance.quote('AAPL')` or maybe a link to a repo -->

## Symbol(s) that it happened for
-
-
-

## Error Message
<!-- Paste the error message here -->
```

```

## Environment
Browser or Node: <!-- Please state either `browser` or `node` here -->
Node version (if applicable):
Npm version:
Browser verion (if applicable):
Library version (e.g. `1.10.1`):

## Additional Context
17 changes: 17 additions & 0 deletions .github/pull_reequest_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
Closes # .

## Changes
-
-
-

## Type
- [ ] New Module
- [ ] Other New Feature
- [ ] Validation Fix
- [ ] Other Bugfix
- [ ] Docs
- [ ] Chore/other

## Comments/notes
<!-- add comments and notes here -->