omarluq · omarluq · Nov 26, 2023 · Nov 26, 2023
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,32 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: 'bug'
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Environment (please complete the following information):**
+ - Stimulus version: [e.g. 2.0.0]
+ - Stimulus Store version: [e.g. 0.0.1-beta]
+ - Node.js version: [e.g. 14.15.1]
+ - Bundler: [e.g. webpack, rollup, parcel]
+ - Bundler version: [e.g. 5.36.2]
+ - Browser: [e.g. Chrome, Safari]
+ - Browser version: [e.g. 89]
+
+**Additional context**
+Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/documentation_update.md b/.github/ISSUE_TEMPLATE/documentation_update.md
@@ -0,0 +1,20 @@
+---
+name: Documentation Update
+about: Propose a change to the project's documentation
+title: ''
+labels: 'documentation'
+assignees: ''
+
+---
+
+**Describe the issue with the documentation**
+A clear and concise description of what the issue is.
+
+**Page Link**
+If applicable, provide the link to the page where the issue is found.
+
+**Suggested Change**
+Describe what changes you believe would improve the documentation.
+
+**Additional context**
+Add any other context or screenshots about the documentation update here.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: 'enhancement'
+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.
diff --git a/.github/ISSUE_TEMPLATE/performance_issue.md b/.github/ISSUE_TEMPLATE/performance_issue.md
@@ -0,0 +1,32 @@
+---
+name: Performance Issue
+about: Report a performance problem or bottleneck
+title: ''
+labels: 'performance'
+assignees: ''
+
+---
+
+**Describe the performance issue**
+A clear and concise description of what the performance issue is.
+
+**Reproduce the performance issue**
+Steps to reproduce the behavior.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Environment (please complete the following information):**
+ - Stimulus version: [e.g. 2.0.0]
+ - Stimulus Store version: [e.g. 0.0.1-beta]
+ - Node.js version: [e.g. 14.15.1]
+ - Bundler: [e.g. webpack, rollup, parcel]
+ - Bundler version: [e.g. 5.36.2]
+ - Browser: [e.g. Chrome, Safari]
+ - Browser version: [e.g. 89]
+
+**Additional context**
+Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/security_issue.md b/.github/ISSUE_TEMPLATE/security_issue.md
@@ -0,0 +1,32 @@
+---
+name: Security Issue
+about: Report a security vulnerability
+title: ''
+labels: 'security'
+assignees: ''
+
+---
+
+**Describe the security issue**
+A clear and concise description of what the security issue is.
+
+**Steps to Reproduce**
+Steps to reproduce the behavior.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Environment (please complete the following information):**
+ - Stimulus version: [e.g. 2.0.0]
+ - Stimulus Store version: [e.g. 0.0.1-beta]
+ - Node.js version: [e.g. 14.15.1]
+ - Bundler: [e.g. webpack, rollup, parcel]
+ - Bundler version: [e.g. 5.36.2]
+ - Browser: [e.g. Chrome, Safari]
+ - Browser version: [e.g. 89]
+
+**Additional context**
+Add any other context about the problem here.
diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md
@@ -0,0 +1,32 @@
+## Description
+
+Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
+
+Fixes # (issue)
+
+## Type of change
+
+Please delete options that are not relevant.
+
+- [ ] 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)
+- [ ] This change requires a documentation update
+
+## How Has This Been Tested?
+
+Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
+
+- [ ] Test A
+- [ ] Test B
+
+## Checklist:
+
+- [ ] My code follows the style guidelines of this project
+- [ ] I have performed a self-review of my own code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] My changes generate no new warnings
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] New and existing unit tests pass locally with my changes
+- [ ] Any dependent changes have been merged and published in downstream modules
diff --git a/CODE_OF_CONDUCT.md b/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
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,49 @@
+# Contributing to stimulus-store
+
+Thank you for your interest in contributing to stimulus-store! We welcome contributions from the community to help make our project better. Before you get started, please take a moment to read this document to understand how you can contribute.
+
+## Table of Contents
+
+- [Contributing to stimulus-store](#contributing-to-stimulus-store)
+  - [Table of Contents](#table-of-contents)
+  - [How to Contribute](#how-to-contribute)
+  - [Reporting Issues](#reporting-issues)
+  - [Pull Requests](#pull-requests)
+
+## How to Contribute
+
+To contribute to stimulus-store, follow these steps:
+
+1. Fork the project on GitHub.
+2. Clone your fork to your local machine.
+3. Create a new branch and check it out.
+4. Make your changes and commit them to your branch.
+5. Push your branch to your fork on GitHub.
+6. Open a pull request from your branch to the main repository's `main` branch.
+
+## Reporting Issues
+
+If you encounter a bug or have a feature request, please [open an issue](https://github.com/omarluq/stimulus-store/issues) on GitHub. Provide as much detail as possible to help us understand and reproduce the issue.
+
+## Pull Requests
+
+When submitting a pull request, please follow these guidelines:
+
+- Use a clear and descriptive title for your pull request.
+- Explain the purpose of your changes in the description.
+- Reference any related issues or pull requests in your description.
+- Make sure your code is well-documented and tested.
+- Keep your pull request focused on a single purpose.
+- Be responsive to feedback
+
+
+We also encourage you to follow the [Conventional Commits](https://www.conventionalcommits.org/) format for your commit messages. Conventional Commits help maintain a clear and organized commit history, making it easier to understand the changes introduced by your pull request.
+
+If you're not familiar with Conventional Commits, here's a brief summary of the format:
+
+- Use a concise and descriptive commit message.
+- Start your commit message with a type, such as `feat`, `fix`, `chore`, etc.
+- Optionally, include a scope to indicate the module or component affected by the change.
+- Write a short and meaningful commit message in the imperative mood (e.g., "fix issue #123" instead of "fixed issue #123" or "fixes issue #123").
+
+Following these guidelines will help streamline the review process and make it easier for maintainers and other contributors to understand the purpose of your changes.
diff --git a/SECURITY.md b/SECURITY.md
@@ -0,0 +1,13 @@
+# Security Policy
+
+## Supported Versions
+
+Use this section to tell people about which versions of your project are currently being supported with security updates.
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 0.0.1-beta   | :white_check_mark: |
+
+## Reporting a Vulnerability
+
+If you discover a security vulnerability within this project, please create a new issue using the "Security Issue" template. All security vulnerabilities will be promptly addressed.