Initial commit

Author: Ma11hewThomas

.github/workflows/main.yaml

@@ -0,0 +1,40 @@
+name: build-and-test
+
+on:
+  push:
+    branches:
+      - '**'
+  pull_request:
+    branches:
+      - '**'
+
+jobs:
+  testing:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+    - name: Install dependencies
+      run: npm install
+    - name: Build
+      run: npm run build
+    - name: lint
+      run: npm run lint
+    - name: Test
+      run: npm run test
+    - name: Publish Test Report
+      uses: ctrf-io/github-test-reporter@v1
+      with:
+        report-path: './ctrf/*.json'
+        github-report: true
+        failed-report: true
+        flaky-report: true
+        insights-report: true
+        fail-rate-report: true
+        flaky-rate-report: true
+        slowest-report: true
+        previous-results-report: true
+        upload-artifact: true
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        if: always()

.gitignore

@@ -0,0 +1,25 @@
+# Dependencies
+node_modules/
+
+# Build output
+dist/
+
+# node_modules
+node_modules/
+
+# Documentation
+docs/
+temp-docs/
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+
+# Coverage  
+coverage/
+
+# Test reports
+ctrf/
+test-data/

CHANGELOG.md

@@ -0,0 +1,55 @@
+# Contributing
+
+First off, thank you for considering contributing to this project.
+
+## Reporting Issues
+
+Before submitting an issue, please check the issue tracker to ensure that the issue hasn't already been reported. If you find your issue already reported, you can subscribe to that issue to receive updates. If you have any additional information to add, please comment on the issue. If the issue is unnasigned and you'd like to contribute, assign the issue to yourself.
+
+## How to Contribute
+
+If you'd like to contribute, start by searching through the issues and pull requests to see whether someone else has raised a similar idea or question.
+
+If you don't see your idea listed, and you think it fits into the goals of this project, do one of the following:
+
+- If your contribution is minor, such as a typo fix, open a pull request.
+- If your contribution is major, or you have not yet decided how to implement your idea, open an issue to discuss it. This allows other contributors to point out any potential flaws or to help you flesh out your idea.
+
+### Pull Requests
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Add your changes and include TSDoc comments for any new helpers
+4. Run tests (`npm test`)
+5. Run linting (`npm run lint`)
+6. Update documentation (`npm run docs:readme`)
+7. Commit your changes (`git commit -m 'Add some amazing feature'`)
+8. Push to the branch (`git push origin feature/amazing-feature`)
+9. Open a Pull Request
+
+### Commit Messages
+
+Write meaningful commit messages that provide insight into the changes made.
+
+## Finding Bugs
+
+If you find a bug, please report it in the issue tracker with a detailed description.
+
+## Feature Requests
+
+Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project. Please provide as much detail and context as possible.
+
+## License
+
+By contributing to this project, you agree that your contributions will be licensed under MIT.
+
+## Acknowledgments
+
+Your contributions are sincerely appreciated. We want to make contributing to this project as easy and transparent as possible, whether it's:
+
+- Reporting a bug
+- Discussing the current state of the code
+- Submitting a fix
+- Proposing new features
+
+Thank you for your interest in contributing

CONTRIBUTING.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Matthew Thomas
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.