Production release

.github/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+All notable changes to the project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.0] - 10/23/2024
+
+### Added
+- Initial release.

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

.github/CONTRIBUTING.md

@@ -0,0 +1,39 @@
+# Contributing to the project!
+
+We welcome contributions! This document provides guidelines and instructions for contributing to this project.
+
+## Getting Started
+
+1. **Fork the Repository**: Begin by forking the repository to your GitHub account.
+2. **Clone the Repository**: Clone your forked repository to your local machine.
+3. **Create a Branch**: Create a new branch for your contribution.
+
+## Contribution Guidelines
+
+- **Code Style**: Follow the established code style in the project.
+- **Commit Messages**: Write meaningful commit messages that clearly explain the changes.
+- **Pull Requests**: Submit pull requests to the `main` branch. Ensure your code is well-tested and documented.
+
+## Submitting Pull Requests
+
+1. **Update Your Fork**: Regularly sync your fork with the main repository to keep it up-to-date.
+2. **Make Your Changes**: Implement your feature or fix.
+3. **Test Your Changes**: Ensure your changes do not break existing functionality.
+4. **Document Your Changes**: Update the README or documentation if necessary.
+5. **Submit a Pull Request**: Push your changes to your fork and open a pull request against the main repository.
+
+## Reporting Issues
+
+- Use the GitHub issue tracker to report bugs or suggest enhancements.
+- Provide as much information as possible, including steps to reproduce the issue.
+- Check if the issue has already been reported to avoid duplicates.
+
+## Code of Conduct
+
+By contributing to this project, you agree to abide by its [Code of Conduct](CODE_OF_CONDUCT.md).
+
+## Questions or Suggestions
+
+Feel free to open an issue or contact the maintainers if you have any questions or suggestions.
+
+Thank you for contributing!

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/PULL_REQUEST_TEMPLATE/pull_request.md

@@ -0,0 +1,33 @@
+---
+name: Pull Request
+about: Propose changes to the codebase
+title: '[PR] '
+labels: enhancement
+assignees: ''
+
+---
+
+**Description of the Changes**
+A clear and concise description of what the pull request does.
+
+**Related Issue**
+Link to the issue that this pull request addresses.
+
+**Motivation and Context**
+Why is this change required? What problem does it solve?
+
+**How Has This Been Tested?**
+Please describe in detail how you tested your changes.
+
+**Screenshots (if appropriate):**
+
+**Types of Changes**
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+
+**Checklist:**
+- [ ] My code follows the project's code style
+- [ ] I have read the CONTRIBUTING document
+- [ ] I have added tests to cover my changes
+- [ ] All new and existing tests passed

.github/SECURITY.md

@@ -0,0 +1,26 @@
+# Security Policy
+
+## Supported Versions
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 1.0.x   | :white_check_mark: |
+| < 1.0   | :x:                |
+
+## Reporting a Vulnerability
+
+We take the security of our software seriously. If you have discovered a security vulnerability in the project, please follow these steps to report it responsibly:
+
+1. **Do Not Publish the Vulnerability**: Avoid sharing the details of the vulnerability in public forums, issues, or other public channels.
+
+2. **Email the Maintainers**: Send an email to the maintainers of the project. Provide a clear description of the vulnerability, including steps to reproduce it.
+
+3. **Wait for Response**: Allow a reasonable amount of time for the maintainers to respond to your report and address the vulnerability.
+
+4. **Disclosure**: After the issue has been resolved and announced, you may consider disclosing the issue to the public in a responsible manner.
+
+We appreciate your efforts to responsibly disclose your findings and will make every effort to acknowledge your contributions.
+
+## Contact Information
+
+For any security concerns, please contact us.

.github/version.json

@@ -0,0 +1,3 @@
+{
+    "version": "v1.0.0"
+}