Merge pull request #17 from veghdev/contributing

CONTRIBUTING.md: set up contributing guide

Author: veghdev

.npmignore

@@ -12,3 +12,4 @@ pull_request_template.md
 
 CODE_OF_CONDUCT.md
 SECURITY.md
+CONTRIBUTING.md

CONTRIBUTING.md

@@ -0,0 +1,41 @@
+# Contributing
+
+# Issues
+
+You can find our open issues in the project's [issue tracker](https://github.com/veghdev/write-npmstat/issues). Please let us know if you find any issues or have any feature requests there.
+
+# Pull requests
+
+A pull request must contain a linked issue, its title should explain the issue or feature shortly and clearly.
+
+# CI check
+
+The `check` script collects the scripts which are run by the `CI` workflow.
+The `CI` workflow invokes the `check-prettier` and the `check-eslint` scripts.
+
+```sh
+npm run check
+```
+
+## Formatting
+
+The write-npmstat project is formatted with `prettier`.
+Run the `check-prettier` script to check that the js files are formatted with `prettier`.
+
+```sh
+npm run check-prettier
+```
+
+`prettier` can be run with the `prettier` script.
+
+```sh
+npm run prettier
+```
+
+## Linter
+
+The `eslint` script runs `eslint` over the write-npmstat project.
+
+```sh
+npm run eslint
+```

README.md

@@ -26,6 +26,10 @@ writenpmstat.datePeriod = "month";
 writenpmstat.writeNpmStat("2022", "2022-03");
 ```
 
+# Contributing
+
+We welcome contributions to the project, visit our [contributing](https://github.com/veghdev/write-npmstat/blob/main/CONTRIBUTING.md) guide for further info.
+
 # Contact
 
 Join our [discussions](https://github.com/veghdev/write-npmstat/discussions) page if you have any questions or comments.

package.json

@@ -7,11 +7,9 @@
     "test": "echo \"Error: no test specified\" && exit 1",
     "prettier": "prettier -w ./*js ./src/*js",
     "eslint": "eslint --fix ./*js ./src/*js",
-    "format": "npm-run-all prettier eslint",
     "check-prettier": "prettier -c ./*js ./src/*js",
     "check-eslint": "eslint ./*js ./src/*js",
-    "check-format": "npm-run-all check-prettier check-eslint",
-    "check": "npm-run-all check-format",
+    "check": "npm-run-all check-prettier check-eslint",
     "rollup": "rollup -c"
   },
   "repository": {