Skip to content

Commit

Permalink
docs: add templates
Browse files Browse the repository at this point in the history
  • Loading branch information
willfarrell committed Jun 29, 2022
1 parent 5a9477c commit dfda31b
Show file tree
Hide file tree
Showing 4 changed files with 83 additions and 0 deletions.
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: bug
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
How to reproduce the behaviour:
1. Sample code '...'
2. Input '....'
3. Unit test '....'
4. Thrown error

**Expected behaviour**
A clear and concise description of what you expected to happen.

**Environment (please complete the following information):**
- Node.js: [e.g. 18]
- csv-rex: [e.g. 0.0.0]
- Browser: [e.g. Firefox 100]

**Additional context**
Add any other context about the problem here.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: feature request
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/pull-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
name: Pull request
about: Pull request
title: ''
labels: ''
assignees: ''

---

<!-- First and foremost, thank you for taking the time to make middy better. You contribution helps everyone. -->

**What does this implement/fix? Explain your changes.**

**Does this close any currently open issues?**

**Any relevant logs, error output, etc?**

**Environment:**
- Node.js: [e.g. 18]
- csv-rex: [e.g. 0.0.0]
- Browser: [e.g. Firefox 100]

**Any other comments?**

**Todo List:**
- [ ] Feature/Fix fully implemented
- [ ] Added tests
- [ ] Unit tests
- [ ] Benchmark tests (if applicable)
- [ ] Updated relevant documentation
- [ ] Updated relevant examples
3 changes: 3 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,13 @@
"type": "module",
"files": [
"index.mjs",
"index.mjs.map",
"index.cjs",
"parse.mjs",
"parse.mjs.map",
"parse.cjs",
"format.mjs",
"format.mjs.map",
"format.cjs"
],
"main": "index.mjs",
Expand Down

0 comments on commit dfda31b

Please sign in to comment.