Skip to content

Commit

Permalink
feat: added more guards, updated dependencies, issue templates and ci/cd
Browse files Browse the repository at this point in the history
fixes #95
  • Loading branch information
Swiftwork committed Oct 3, 2022
1 parent d503b2e commit 8879731
Show file tree
Hide file tree
Showing 13 changed files with 4,448 additions and 6,398 deletions.
38 changes: 0 additions & 38 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

77 changes: 77 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
name: 🐛 Bug Report
description: Create a bug report to help us improve
labels: [🐛 bug]
body:
- type: markdown
attributes:
value: |
### Thank you for reporting a bug but before you do please...
1. Check for existing open/closed issues for a possible duplicate before creating a new issue: https://github.com/trutoo/event-bus/issues
### Help us help you better
- type: input
id: description
attributes:
label: Description
description: A clear and concise description of what you expected to happen.
placeholder: |
What is the bug? And why is it a bug?
validations:
required: true

- type: textarea
id: steps
attributes:
label: Steps to reproduce
description: |
Let us know how we reproduce it too.
value: |
1. Go to '...'
2. Click on '...'
3. Scroll down to '...'
4. See error
- type: input
id: library-version
attributes:
label: Library Version
description: The version of library you are using.
placeholder: 1.0.0
validations:
required: true

- type: checkboxes
id: browser
attributes:
label: Browser
description: The browser(s) this issue occurred on
options:
- label: Chrome
- label: Edge*
- label: Safari
- label: Firefox
- label: Opera
- label: IE
- label: Other

- type: checkboxes
id: platform
attributes:
label: Platform
description: The platform(s) this issue occurred on
options:
- label: Windows
- label: MacOS
- label: Linux
- label: Android
- label: iOS
- label: Other

- type: textarea
id: additional-information
attributes:
label: Additional Information
description: |
Use this section to provide any additional information you might have like screenshots, notes, or links to ideas.
placeholder: Any and every additional information is always welcome
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

48 changes: 48 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
name: ✨ Feature Request
description: Request a feature or enhancement
labels: [✨ feature]
body:
- type: markdown
attributes:
value: |
### Thank you for requesting a feature but before you do please...
1. Check for existing open/closed issues for a possible duplicate before creating a new issue: https://github.com/trutoo/event-bus/issues
### Help us help you better
- type: textarea
id: justification
attributes:
label: Problem Statement
description: |
Please provide valid reason(s) why this should be a part of @trutoo/event-bus.
Is this feature meant to solve an existing problem, if so please mention it as well.
placeholder: A clear and concise description of what the problem is. Ex. I am always frustrated when [...]
validations:
required: true

- type: textarea
id: proposed-solution
attributes:
label: Proposed Solution
description: |
Please provide a description on how you would like the feature to work.
placeholder: A clear and concise description of what you want to happen.
validations:
required: true

- type: textarea
id: alternatives
attributes:
label: Alternatives
description: |
Describe alternatives you have considered.
placeholder: A clear and concise description of any alternative solutions or features you have considered.

- type: textarea
id: additional-information
attributes:
label: Additional Information
description: |
What resources (links, inspirations, designs, screenshots, etc.) do you have to assist this effort?
placeholder: Any and every additional information is always welcome
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/question_documentation.md

This file was deleted.

37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/question_documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: ❓ Question
description: Question or documentation improvement
labels: [❓ question]
body:
- type: textarea
id:
attributes:
label: What is hard to understand or you feel lacks information? Please describe.
description: |
A clear and concise description where the confusion lies. Ex. I don't understand the [...]
validations:
required: true

- type: textarea
id:
attributes:
label: Describe your current understanding
description: |
A clear and concise description of how you interpret the situation.
validations:
required: true

- type: textarea
id:
attributes:
label: Describe the improvement you'd like
description: |
A clear and concise description of what you want to see.
validations:
required: true

- type: textarea
id:
attributes:
label: Additional context
description: |
Add any other context or screenshots about the question or documentation here.
6 changes: 3 additions & 3 deletions .github/workflows/cd.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ on:

jobs:
delivery:
name: Node 16.x
name: Node 18.x
runs-on: ubuntu-latest

steps:
Expand All @@ -22,10 +22,10 @@ jobs:
git config --global user.name "GitHub Action"
git config --global user.email "[email protected]"
- name: Set up Node.js version 16.x
- name: Set up Node.js version 18.x
uses: actions/setup-node@v3
with:
node-version: 16.x
node-version: 18.x
registry-url: https://npm.pkg.github.com
scope: trutoo

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ jobs:

strategy:
matrix:
node: [14.x, 16.x, 17.x]
node: [16.x, 17.x, 18.x]

steps:
- name: Check out source code
Expand Down
8 changes: 2 additions & 6 deletions jest.config.js
Original file line number Diff line number Diff line change
@@ -1,11 +1,7 @@
module.exports = {
preset: 'ts-jest',
globals: {
'ts-jest': {
tsconfig: {
target: 'es6',
},
},
transform: {
'^.+\\.tsx?$': ['ts-jest', { tsconfig: { target: 'es6' } }],
},
collectCoverage: true,
collectCoverageFrom: ['src/**/*.ts', '!src/**/*.d.ts'],
Expand Down
Loading

0 comments on commit 8879731

Please sign in to comment.