Skip to content

Commit e64b789

Browse files
authored
feat: update readme + feat: add a pull rquest template (#2)
* feat: update readme - Add logo - Add install steps - Reword * feat: add a pull rquest template
1 parent a5f16d3 commit e64b789

File tree

3 files changed

+79
-3
lines changed

3 files changed

+79
-3
lines changed

.github/pull_request_template.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Description
2+
3+
Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change.
4+
5+
Fixes # (issue)
6+
7+
## Type of change
8+
9+
Please delete options that are not relevant.
10+
11+
- [ ] Bug fix (non-breaking change which fixes an issue)
12+
- [ ] New feature (non-breaking change which adds functionality)
13+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
14+
- [ ] This change requires a documentation update
15+
16+
# How Has This Been Tested?
17+
18+
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
19+
20+
- [ ] Test A
21+
- [ ] Test B
22+
23+
**Test Configuration**:
24+
* Firmware version:
25+
* Hardware:
26+
* Toolchain:
27+
* SDK:
28+
29+
# Checklist:
30+
31+
- [ ] My code follows the style guidelines of this project
32+
- [ ] I have performed a self-review of my code
33+
- [ ] I have commented my code, particularly in hard-to-understand areas
34+
- [ ] I have made corresponding changes to the documentation
35+
- [ ] My changes generate no new warnings
36+
- [ ] I have added tests that prove my fix is effective or that my feature works
37+
- [ ] New and existing unit tests pass locally with my changes
38+
- [ ] Any dependent changes have been merged and published in downstream modules

.github/tnmt-logo.png

131 KB
Loading

README.md

Lines changed: 41 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,48 @@
1-
# INTRODUCTION
2-
Sample node module boilerplate by Tib0
1+
![logo](./.github/tnmt-logo.png)
32

3+
Sample node module template by Tib0. Shipped with:
4+
- [x] Github's actions
5+
- [x] VSCode config
6+
- [x] Node config
7+
- [x] TypeScript
8+
- [x] Prettier
9+
- [x] Eslint
10+
- [x] Tsup
11+
- [x] Pnpm
12+
- [x] Jest
13+
14+
# USE
15+
Follow these steps to make it yours :
16+
17+
1. Clone the repository :
18+
```sh
19+
git clone https://github.com/tib0/typescript-node-module-template.git
20+
```
21+
22+
2. Update package.json entries (author, name...)
23+
```sh
24+
code typescript-node-module-template\package.json
25+
```
26+
27+
3. Rename folder `typescript-node-module-template` to whatever suit your needs.
28+
```sh
29+
mv typescript-node-module-template\ <target name>\
30+
```
31+
32+
4. Remove git history :
33+
```sh
34+
rm -rf .git && git init && git add . && git commit -m "Initial commit"
35+
```
36+
37+
5. Push :
38+
```sh
39+
git push
40+
```
441

542
# WARNING
6-
Warning triggered when using eslint in version 9.1.1 due to unmet dependency
43+
Warning triggered when using eslint in version 9.1.1 due to unmet dependency, I had to downgrade to [email protected]. It avoids using two versions of the same dependency.
744

45+
Warning seen:
846
> "eslint": "^9.1.1" cause WARN  Issues with peer dependencies found
947
```txt
1048
.

0 commit comments

Comments
 (0)