Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
webdiscus committed Sep 21, 2023
1 parent 65d94a9 commit 7fca74c
Show file tree
Hide file tree
Showing 14 changed files with 448 additions and 286 deletions.
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/Bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
name: Bug report
about: Create a report to help us improve
---

<!-- If you delete this template this issue is very likely to be closed. -->

## Current behaviour

<!-- Tell us which problem you are facing which might be caused by a bug. -->

## Expected behaviour

<!-- If not included in current behaviour please explain what should happen instead. -->

### Reproduction Example

<!-- Please provide a minimal example how to reproduce your problem. -->

## Environment

<!-- Tell us versions of your environment: -->

- OS: [macOS, Linux, Windows]
- version of Node.js:
- version of Webpack:
- version of the Plugin:

## Additional context

<!-- Add any other context about the problem here. -->
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/Feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
name: Feature request
about: Suggest an idea for this project
---

<!-- If you delete this template this issue is very likely to be closed. -->

## Feature request

**What is motivation or use case for adding/changing the behavior?**
<!-- 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. -->
6 changes: 6 additions & 0 deletions .github/ISSUE_TEMPLATE/Other.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
name: Custom issue
about: Something else
---

<!-- Bug reports and Feature requests must use other templates, or will be closed -->
27 changes: 0 additions & 27 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

44 changes: 44 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
## Types of changes

<!-- Please place an `x` in all [ ] that apply: -->

This PR contains a:

- [ ] **bugfix**
- [ ] new **feature**
- [ ] **code refactor**
- [ ] **test update** <!-- if bug or feature is checked, this should be too -->
- [ ] **typo fix**
- [ ] **docs change**
- [ ] **breaking change** <!-- fix or feature that change existing functionality -->

## Motivation / Use-Case

<!--
Please explain the motivation or use-case for your change.
What existing problem does the PR solve?
If this PR addresses an issue, please link to the issue.
-->

## Breaking Changes

<!--
If this PR introduces a breaking change, please describe the impact and a
migration path for existing applications.
-->

## Additional Info

---

## Checklist

<!-- Go over all the following points, and place an `x` in all the boxes that apply. -->

- [ ] My code follows the code style of this project.
- [ ] My change requires a change to the documentation.
- [ ] I have updated the documentation accordingly.
- [ ] I have updated the **CHANGELOG.md**.
- [ ] I have read the **CONTRIBUTING** document.
- [ ] I have added tests to cover my changes.
- [ ] All new and existing tests passed.
34 changes: 21 additions & 13 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -1,34 +1,42 @@
name: Running Code Coverage

on: [ push, pull_request ]
name: Test

on:
push:
branches:
- master
- next
pull_request:
branches:
- master
- next

jobs:
build:

runs-on: ubuntu-latest

integration:
strategy:
matrix:
node-version: [ 12.x, 14.x, 16.x ]
os: [ubuntu-latest]
node-version: [12, 14, 16, 18, 20]

runs-on: ${{ matrix.os }}
steps:
- name: Checkout repository
uses: actions/checkout@v2
uses: actions/checkout@v3
with:
fetch-depth: 2
fetch-depth: 1

- name: Set up Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v1
uses: actions/setup-node@v3
with:
node-version: ${{ matrix.node-version }}

- name: Install dependencies
run: npm install
run: npm i

- name: Run the tests
run: npm run test:coverage

- name: Submit coverage data to codecov
uses: codecov/codecov-action@v1
uses: codecov/codecov-action@v3
with:
flags: integration
token: ${{ secrets.CODECOV_TOKEN }}
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# Change log

## 1.5.6 (2023-09-21)
- chore: update dev dependencies
- chore: add SECURITY.md
- chore: add PULL_REQUEST_TEMPLATE.md
- chore: update ISSUE_TEMPLATE
- docs: update readme

## 1.5.5 (2022-09-22)
- refactor: optimize code to reduce size by 120 bytes
- test: added test for isSupported() function
Expand Down
1 change: 1 addition & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[Code of Conduct](https://github.com/openjs-foundation/code-and-learn/blob/master/CODE_OF_CONDUCT.md)
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
ISC License

Copyright (c) 2022, webdiscus
Copyright (c) 2023, webdiscus

Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
Expand Down
Loading

0 comments on commit 7fca74c

Please sign in to comment.