Skip to content

Commit 8757e9e

Browse files
lengocduylengocduy
committed
docs(README): add guidelines more clearer
1 parent 895f0ab commit 8757e9e

File tree

4 files changed

+24
-7
lines changed

4 files changed

+24
-7
lines changed

‎README.md‎

Lines changed: 24 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@ The following tools need to be installed:
1111

1212
## Capabilities and Frameworks
1313

14-
| Capability | Module |
15-
| -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
16-
| Dependence Framework | [`@tsconfig/node18`](https://www.npmjs.com/package/@tsconfig/node18) extend ts config node18+, [typescript](https://www.npmjs.com/package/typescript) adds optional types to JavaScript that support tools for large-scale JavaScript applications |
17-
| Build Tools | [`tsup`](https://tsup.egoist.dev) Bundle your TypeScript library with no config, powered by esbuild |
18-
| Coding Standard | [eslint](https://eslint.org/) statically analyzes your code to quickly find and fix problems based on opt-in [rules](https://eslint.org/docs/latest/rules/), [prettier](https://prettier.io/docs/en/) an opinionated code formatter to build and enforce a style guide on save, [eslint-config-prettier](https://github.com/prettier/eslint-config-prettier) to turns off all rules that are unnecessary or might conflict with Prettier. |
19-
| Testing Framework | [Jest](https://jestjs.io/) a delightful JavaScript Testing Framework with a focus on simplicity. |
20-
| Useful Links | [npmtrends](https://npmtrends.com/) Compare package download counts over time, [act](https://nektosact.com/introduction.html) run your GitHub Actions locally, [Actionlint](https://marketplace.visualstudio.com/items?itemName=arahata.linter-actionlint) static checker for GitHub Actions workflow files |
14+
| Capability | Module |
15+
| -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
16+
| Dependence Framework | [`@tsconfig/node18`](https://www.npmjs.com/package/@tsconfig/node18) extend ts config node18+, [typescript](https://www.npmjs.com/package/typescript) adds optional types to JavaScript that support tools for large-scale JavaScript applications |
17+
| Build Tools | [`tsup`](https://tsup.egoist.dev) Bundle your TypeScript library with no config, powered by esbuild |
18+
| Coding Standard | [eslint](https://eslint.org/) statically analyzes your code to quickly find and fix problems based on opt-in [rules](https://eslint.org/docs/latest/rules/), [prettier](https://prettier.io/docs/en/) an opinionated code formatter to build and enforce a style guide on save, [eslint-config-prettier](https://github.com/prettier/eslint-config-prettier) to turns off all rules that are unnecessary or might conflict with Prettier. |
19+
| Testing Framework | [Jest](https://jestjs.io/) a delightful JavaScript Testing Framework with a focus on simplicity. |
20+
| Useful Links | [npmtrends](https://npmtrends.com/) Compare package download counts over time, [act](https://nektosact.com/introduction.html) run your GitHub Actions locally, [Actionlint](https://marketplace.visualstudio.com/items?itemName=arahata.linter-actionlint) static checker for GitHub Actions workflow files, [share-dev-environments](https://github.com/make-everything-simple/share-dev-environments) quick setup by running some commands to align development environment among machines or developers |
2121

2222
## How to test
2323

@@ -50,6 +50,23 @@ npm install | yarn install
5050

5151
we can manage our package.json via [npm-pkg](https://docs.npmjs.com/cli/v10/commands/npm-pkg)
5252

53+
```bash
54+
npm pkg set <key>=<value> [<key>=<value> ...]
55+
npm pkg get [<key> [<key> ...]]
56+
npm pkg delete <key> [<key> ...]
57+
npm pkg set [<array>[<index>].<key>=<value> ...]
58+
npm pkg set [<array>[].<key>=<value> ...]
59+
npm pkg fix
60+
```
61+
62+
### Configure necessary credentials
63+
64+
1. Generate a Granular Access Token on [npmjs.com](https://www.npmjs.com/) ![NPM_TOKEN](./arts/generate-access-token-npmjs.png)
65+
1. github package: TBU
66+
2. Configure in your repository's secret variables
67+
1. Individual level ![Individual](./arts/create-secret-variable-for-individual.png)
68+
2. Organization level to share across repositories on-demand ![Organization](./arts/create-secret-variable-for-organization.png)
69+
5370
## Collaboration
5471
5572
1. We use the git rebase strategy to keep tracking meaningful commit message. Help to enable rebase when pull `$ git config --local pull.rebase true`

‎arts/create-secret-variable-for-individual.png‎

383 KB
Loading

‎arts/create-secret-variable-for-organization.png‎

373 KB
Loading

‎arts/generate-access-token-npmjs.png‎

259 KB
Loading

0 commit comments

Comments
 (0)