0.0.5 (#5)

.github/code_of_conduct.md

@@ -0,0 +1,132 @@
+# 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, caste, color, 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
+[INSERT CONTACT METHOD].
+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.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

.github/contributing.md

@@ -0,0 +1,49 @@
+# Contributing to Olallie
+
+Thank you for contributing to Olallie! Appreciate your efforts to make the project better.
+
+## Getting Started
+
+Before you start contributing, please make sure you have read the [Code of Conduct](code_of_conduct.md). By participating in this project, you agree to abide by its terms.
+
+## How Can I Contribute?
+
+### Reporting Bugs
+
+If you come across a bug or unexpected behavior in Olallie, please help by submitting a bug report by follow these steps:
+
+1. **Search for Existing Issues:** Before creating a new issue, check if the problem has already been reported. If it has, you can contribute to the existing discussion.
+
+2. **Create a New Issue:**
+  - Clearly describe the issue, including steps to reproduce it.
+  - If applicable, attach relevant screenshots, or error log.
+  - Use the "Bug" issue template if available.
+
+3. **Create a Vitest Spec:**
+  - For bug reports, please create a [vitest spec](https://vitest.dev/) that reproduces the issue.
+
+### Contributing Code
+
+If you're interested in contributing code, follow these steps:
+
+1. **Clone the Repository:** Pull the Olallie repository on GitHub.
+
+2. **Create a New Branch:** Create a new branch for your changes.
+
+  ```bash
+  git checkout -b your-feature
+  ```
+
+3. **Make Changes:** Make your changes, and ensure that your code adheres to the project's coding standards.
+
+4. **Test your Changes:** Write new tests, and esnure the current suite is passing.
+
+5. **Create a Pull Request:** Push your changes to your branch, and create a pull request against `main`.
+
+6. **Follow the Code Review Process:** Participate in the code review process, and address any feedback.
+
+## Code of Conduct
+
+Help keep Olallie open and inclusive. Please read and follow the [Code of Conduct](code_of_conduct.md).
+
+Thank you for your contribution!

.github/pull_request_template.md

@@ -0,0 +1,8 @@
+### Changes Proposed in this Pull Request:
+* 
+
+### Important Links (Useful documentation, references, etc)
+* 
+
+### Additional Information (Optional)
+* 

.github/workflows/spec.yml

@@ -0,0 +1,22 @@
+name: Lint & Unit Test
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Use Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '21.x'
+      - run: npm ci
+      - run: npm run spec
+

.nvmrc

@@ -1 +1 @@
-v21.4.0
+v21.6.2

CHANGELOG.md

@@ -1,6 +1,12 @@
+# 0.0.5
+- Functionality change
+  - See [0.0.5](https://github.com/AidanHibbard/Olallie/pull/5)
+- Update docs
+- Lint
+
 # 0.0.4
 - Change listeners usage
-- Fix non-existent store properties coming back as generic types
+- Fix non-existent store properties coming back as generic method type
 - Update docs
 
 # 0.0.3