project clean up

.vscode/tasks.json

@@ -0,0 +1,48 @@
+{
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "yarn lint",
+      "type": "shell",
+      "command": "yarn lint",
+      "group": "build",
+      "presentation": {
+        "reveal": "always"
+      },
+      "problemMatcher": []
+    },
+    {
+      "label": "yarn build",
+      "type": "shell",
+      "command": "yarn build",
+      "group": {
+        "kind": "build",
+        "isDefault": true
+      },
+      "presentation": {
+        "reveal": "always"
+      },
+      "problemMatcher": []
+    },
+    {
+      "label": "yarn test",
+      "type": "shell",
+      "command": "yarn test",
+      "group": "test",
+      "presentation": {
+        "reveal": "always"
+      },
+      "problemMatcher": []
+    },
+    {
+      "label": "yarn docs",
+      "type": "shell",
+      "command": "yarn docs",
+      "group": "build",
+      "presentation": {
+        "reveal": "always"
+      },
+      "problemMatcher": []
+    }
+  ]
+}

CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [Unreleased]
+
+## [1.0.0] - 2023-11-01

CONTRIBUTING.md

@@ -0,0 +1,67 @@
+# Contributing to maidr
+
+Thank you for your interest in contributing to maidr project! We welcome contributions from everyone.
+
+## Getting Started
+
+To get started, please follow these steps:
+
+1. Fork the repository on GitHub.
+
+2. Clone your forked repository to your local machine.
+
+3. install `npm` if you don't have it already (version 9 or higher is recommended).
+
+4. Install `yarn` if you don't have it already. You can install it by running the following command in your terminal:
+
+```shell
+npm install -g yarn
+``````
+
+5. In the forked project root, install the dependencies by running the following command in your terminal:
+
+```shell
+yarn install
+```
+
+5. Make changes.
+
+6. Run `yarn lint` to lint the code.
+
+7. Run `yarn build` to build the project.
+
+8. Run `yarn test` to run the tests.
+
+9. Run `yarn docs` to generate the documentation.
+
+10. Test the new features locally.
+
+11. Commit your changes and push them to your forked repository.
+
+12. Create a pull request to the main repository.
+
+## Guidelines
+
+Please follow these guidelines when contributing to the project:
+
+- Use JavaScript (es6) for all code.
+- Write clear and concise commit messages.
+- Follow the code style and formatting guidelines.
+- Write tests for new features and bug fixes.
+- Update the documentation as needed in `CHANGELOG.md`.
+
+## Code Style and Formatting
+
+We use ESLint to enforce a consistent code style and formatting. Please run `yarn lint` before committing your changes to ensure that your code meets the standards.
+
+## Tests
+
+We use Jest for unit testing. Please run `yarn test` before committing your changes to ensure that your changes do not break any existing tests.
+
+## Documentation
+
+We use jsdoc for documentation. Please update the relevant documentation in js files when making changes to the project.
+
+## Code of Conduct
+
+Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.