project bootstrap

2023-11-25 18:12:47 -05:00
parent 5cd875ae80
commit 6ef22d88f9
39139 changed files with 4944609 additions and 2 deletions
@@ -0,0 +1,28 @@
+# Contribution guidelines
+
+* Install/update the dependencies:
+  ```
+  npm i
+  ```
+
+* Make sure all of the tests pass:
+  ```
+  npm t
+  ```
+
+* Make sure the code lints:
+  ```
+  npm run lint
+  ```
+
+* Adhere to the coding conventions
+  that are used elsewhere in the codebase.
+
+* New code must have new unit tests.
+
+* New features
+  or changes to existing features
+  must be documented in the [readme file](README.md).
+
+* Add yourself to the [authors file](AUTHORS).
+