repositories
/
poolifier.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
chore: v3.1.30
[poolifier.git]
/
CONTRIBUTING.md
diff --git
a/CONTRIBUTING.md
b/CONTRIBUTING.md
index c148e5a0867fd3172db2b1b2048b1d0409dda96c..fc6dfaed44b22c35cb5c6f8c06a87038e348abb2 100644
(file)
--- a/
CONTRIBUTING.md
+++ b/
CONTRIBUTING.md
@@
-1,38
+1,36
@@
## How to contribute
## How to contribute
+This repo use standard js style, please use it if you want to contribute.
[![JavaScript Style Guide](https://cdn.rawgit.com/standard/standard/master/badge.svg)](https://github.com/standard/standard)
[![JavaScript Style Guide](https://cdn.rawgit.com/standard/standard/master/badge.svg)](https://github.com/standard/standard)
-This repo use standard js style, please use it if you want to contribute
Take tasks from todo list, develop a new feature or fix a bug and do a pull request.
Take tasks from todo list, develop a new feature or fix a bug and do a pull request.
-Another thing that you can do to contribute is to build something on top of
ring-election and link ring-election to your project
+Another thing that you can do to contribute is to build something on top of
poolifier and link poolifier to your project.
-Please
ask your PR to be merged
on **master** branch.
+Please
do your PR
on **master** branch.
-**How to run tests**
-
-**Unit tests**
+**How to run unit tests and coverage**
```bash
```bash
- npm run test
+ pnpm test && pnpm coverage
```
```
-**How to check if your new code is standard style**
+**How to check if your new code is standard
JS
style**
```bash
```bash
-
npm run
lint
+
pnpm
lint
```
```
-**How to
lint and format (with prettier)
your code**
+**How to
format and lint to standard JS style
your code**
```bash
```bash
-
npm run format && npm run
lint:fix
+
pnpm format && pnpm
lint:fix
```
### Project pillars
Please consider our pillars before to start change the project
```
### Project pillars
Please consider our pillars before to start change the project
-- Performance :
racehorse
:
-- Security :
bank: :cop
:
+- Performance :
white_check_mark
:
+- Security :
white_check_mark
:
- No runtime dependencies :white_check_mark: (until now we don't have any exception to that)
- No runtime dependencies :white_check_mark: (until now we don't have any exception to that)
-- Easy to use :
couple
:
-- Code quality :
octocat
:
+- Easy to use :
white_check_mark
:
+- Code quality :
white_check_mark
: