[project] CONTRIBUTING.md added

This commit is contained in:
Revone 2023-10-11 23:14:35 +08:00
parent f85073bebe
commit 071cea8bd0
3 changed files with 47 additions and 29 deletions

View file

@ -0,0 +1,18 @@
## Contributing
**General Rules**
- As much as possible, try to follow the existing format of markdown and code.
- Don't forget to run `npm run lint` and `npm test` before submitting pull requests.
- Make sure that **100%** of your code is covered by tests.
**Contributing New Data Structures**
- Make your pull requests to be **specific** and **focused**. Instead of
contributing "several data structures" all at once contribute them all
one by one separately (i.e. one pull request for "RBTree", another one
for "AATree" and so on).
- Provide **README.md** for each of the data structure **with explanations** of
the algorithm and **with links** to further readings.
- Describe what you do in code using **comments**.

50
package-lock.json generated
View file

@ -1,12 +1,12 @@
{
"name": "data-structure-typed",
"version": "1.34.9",
"version": "1.35.0",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "data-structure-typed",
"version": "1.34.9",
"version": "1.35.0",
"license": "MIT",
"devDependencies": {
"@types/benchmark": "^2.1.3",
@ -15,17 +15,17 @@
"@typescript-eslint/eslint-plugin": "^6.7.4",
"@typescript-eslint/parser": "^6.7.4",
"auto-changelog": "^2.4.0",
"avl-tree-typed": "^1.34.8",
"avl-tree-typed": "^1.35.0",
"benchmark": "^2.1.4",
"binary-tree-typed": "^1.34.8",
"bst-typed": "^1.34.8",
"binary-tree-typed": "^1.35.0",
"bst-typed": "^1.35.0",
"dependency-cruiser": "^14.1.0",
"eslint": "^8.50.0",
"eslint-config-prettier": "^9.0.0",
"eslint-import-resolver-alias": "^1.1.2",
"eslint-import-resolver-typescript": "^3.6.1",
"eslint-plugin-import": "^2.28.1",
"heap-typed": "^1.34.8",
"heap-typed": "^1.35.0",
"istanbul-badges-readme": "^1.8.5",
"jest": "^29.7.0",
"prettier": "^3.0.3",
@ -2393,12 +2393,12 @@
}
},
"node_modules/avl-tree-typed": {
"version": "1.34.8",
"resolved": "https://registry.npmjs.org/avl-tree-typed/-/avl-tree-typed-1.34.8.tgz",
"integrity": "sha512-5f4zkcP3qspipM0OJ1VY5t/77wbWHOto5QgUCX+YuXMlpkMwquAiTg7hSqOQJaLFCmol28BkfdxJfzVB0T08Kg==",
"version": "1.35.0",
"resolved": "https://registry.npmjs.org/avl-tree-typed/-/avl-tree-typed-1.35.0.tgz",
"integrity": "sha512-8OBbwPK4szObPywI9EYmF3KHbxdfaLcG235hoKxDkCni0kDhco02byfI2XMkrulNess14+klFmUIjHi6GhVIUQ==",
"dev": true,
"dependencies": {
"data-structure-typed": "^1.34.8"
"data-structure-typed": "^1.35.0"
}
},
"node_modules/babel-jest": {
@ -2583,12 +2583,12 @@
}
},
"node_modules/binary-tree-typed": {
"version": "1.34.8",
"resolved": "https://registry.npmjs.org/binary-tree-typed/-/binary-tree-typed-1.34.8.tgz",
"integrity": "sha512-sDsvV0tvs1tullwIoA6/gak+9vHQAOnXQvbNn9SyMBp2IMeIhNRC9SpHKPU75AgtBiSqVJ3qxMYE6uw360UzcQ==",
"version": "1.35.0",
"resolved": "https://registry.npmjs.org/binary-tree-typed/-/binary-tree-typed-1.35.0.tgz",
"integrity": "sha512-RdOMokIP2qhRV5OiVt2nF/zIO7KpkKLyB4j4/w0TJASMlDF/X0JdouAcECYvcgbegH0WMWKE5N9Iko0dsC4J3Q==",
"dev": true,
"dependencies": {
"data-structure-typed": "^1.34.8"
"data-structure-typed": "^1.35.0"
}
},
"node_modules/brace-expansion": {
@ -2667,12 +2667,12 @@
}
},
"node_modules/bst-typed": {
"version": "1.34.8",
"resolved": "https://registry.npmjs.org/bst-typed/-/bst-typed-1.34.8.tgz",
"integrity": "sha512-sEqjh8ouZaCD5Tt6IicNTNaeYzpSdeaVRBiHXtYdla5YAMRpiBepw+O1gfwOpKlLTNqVY/wEt2zGgtWmfLKB+Q==",
"version": "1.35.0",
"resolved": "https://registry.npmjs.org/bst-typed/-/bst-typed-1.35.0.tgz",
"integrity": "sha512-sROm+OgzOfwJHGppyF2M07SjRLkjg+pL7V6Q8jxC2knGuDz48fBEslWGzcXY8QXlDI01Ry+oT2I13XMztMPEWw==",
"dev": true,
"dependencies": {
"data-structure-typed": "^1.34.8"
"data-structure-typed": "^1.35.0"
}
},
"node_modules/buffer-from": {
@ -3024,9 +3024,9 @@
}
},
"node_modules/data-structure-typed": {
"version": "1.34.8",
"resolved": "https://registry.npmjs.org/data-structure-typed/-/data-structure-typed-1.34.8.tgz",
"integrity": "sha512-8pQJxRvlOHnZ6pwgk2BZWKhd8hxkV+waJgX0SIS3tSJv00WB0vRfg610pLWuBxBdnmnFvFIX6HGFUUH6ERRDIw==",
"version": "1.35.0",
"resolved": "https://registry.npmjs.org/data-structure-typed/-/data-structure-typed-1.35.0.tgz",
"integrity": "sha512-Z3ikrs4DfH0rkoAl6zHCJZaiJXk/B1H/OJM+b0wmOs/VBxQbL8bR1C0ddRUU3oHgn/sHclQHkgKSJjAbew6ppQ==",
"dev": true
},
"node_modules/debug": {
@ -4356,12 +4356,12 @@
}
},
"node_modules/heap-typed": {
"version": "1.34.8",
"resolved": "https://registry.npmjs.org/heap-typed/-/heap-typed-1.34.8.tgz",
"integrity": "sha512-jgd/JSdk3qZKI1luGL+O48plcIAxv6ZGPbb4bA0iVOs1jBXAZLQam92Yc91DkU2a8tSW+5c8sBIy3CkGE3ZRrA==",
"version": "1.35.0",
"resolved": "https://registry.npmjs.org/heap-typed/-/heap-typed-1.35.0.tgz",
"integrity": "sha512-uSvnquwGTNxw0DsH85mp9D6LMXT3F14enPkrYVrTxShiwaxQVWHmdfYgLVFOW73vNlKR5pRUqbBtUJ6mA+IUNA==",
"dev": true,
"dependencies": {
"data-structure-typed": "^1.34.8"
"data-structure-typed": "^1.35.0"
}
},
"node_modules/html-escaper": {

View file

@ -50,17 +50,17 @@
"@typescript-eslint/eslint-plugin": "^6.7.4",
"@typescript-eslint/parser": "^6.7.4",
"auto-changelog": "^2.4.0",
"avl-tree-typed": "^1.34.8",
"avl-tree-typed": "^1.35.0",
"benchmark": "^2.1.4",
"binary-tree-typed": "^1.34.8",
"bst-typed": "^1.34.8",
"binary-tree-typed": "^1.35.0",
"bst-typed": "^1.35.0",
"dependency-cruiser": "^14.1.0",
"eslint": "^8.50.0",
"eslint-config-prettier": "^9.0.0",
"eslint-import-resolver-alias": "^1.1.2",
"eslint-import-resolver-typescript": "^3.6.1",
"eslint-plugin-import": "^2.28.1",
"heap-typed": "^1.34.8",
"heap-typed": "^1.35.0",
"istanbul-badges-readme": "^1.8.5",
"jest": "^29.7.0",
"prettier": "^3.0.3",