diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..1596d89 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,38 @@ +# Description + +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. + +Fixes # (issue) + +## Type of change + +Please delete options that are not relevant. + +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] This change requires a documentation update + +# How Has This Been Tested? + +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 + +- [ ] Test A +- [ ] Test B + +**Test Configuration**: +* Firmware version: +* Hardware: +* Toolchain: +* SDK: + +# Checklist: + +- [ ] My code follows the style guidelines of this project +- [ ] I have performed a self-review of my code +- [ ] I have commented my code, particularly in hard-to-understand areas +- [ ] I have made corresponding changes to the documentation +- [ ] My changes generate no new warnings +- [ ] I have added tests that prove my fix is effective or that my feature works +- [ ] New and existing unit tests pass locally with my changes +- [ ] Any dependent changes have been merged and published in downstream modules \ No newline at end of file diff --git a/.github/tnmt-logo.png b/.github/tnmt-logo.png new file mode 100644 index 0000000..3ed5ee1 Binary files /dev/null and b/.github/tnmt-logo.png differ diff --git a/README.md b/README.md index 759082b..d301882 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,48 @@ -# INTRODUCTION -Sample node module boilerplate by Tib0 +![logo](./.github/tnmt-logo.png) +Sample node module template by Tib0. Shipped with: +- [x] Github's actions +- [x] VSCode config +- [x] Node config +- [x] TypeScript +- [x] Prettier +- [x] Eslint +- [x] Tsup +- [x] Pnpm +- [x] Jest + +# USE +Follow these steps to make it yours : + +1. Clone the repository : +```sh +git clone https://github.com/tib0/typescript-node-module-template.git +``` + +2. Update package.json entries (author, name...) +```sh +code typescript-node-module-template\package.json +``` + +3. Rename folder `typescript-node-module-template` to whatever suit your needs. +```sh +mv typescript-node-module-template\ \ +``` + +4. Remove git history : +```sh +rm -rf .git && git init && git add . && git commit -m "Initial commit" +``` + +5. Push : +```sh +git push +``` # WARNING -Warning triggered when using eslint in version 9.1.1 due to unmet dependency +Warning triggered when using eslint in version 9.1.1 due to unmet dependency, I had to downgrade to eslint@8.56.0. It avoids using two versions of the same dependency. +Warning seen: > "eslint": "^9.1.1" cause WARN  Issues with peer dependencies found ```txt .