Initial commit

.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
+[email protected].
+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,46 @@
+# Contributing Guide
+Welcome! We appreciate your interest in contributing.
+
+## Issues
+
+Report bugs using GitHub's Issue Tracker.
+A useful bug report has detail, background, and sample code.
+For example, try to include:
+
+- A quick summary and/or background.
+- Steps to reproduce:
+  - Be specific!
+  - Give sample code if you can.
+- What you expected would happen.
+- What actually happens.
+- Any additional information that could help us.
+  - Why you think this might be happening.
+  - Things you tried that didn't work.
+  - Etc.
+
+## Pull Requests
+
+We use the [Github Flow](https://docs.github.com/en/get-started/quickstart/github-flow), so all changes happen through pull requests.
+
+For small bugs, feel free to open a pull request directly.
+For larger bugs or enhancements, please open an issue first
+Having an associated issue makes it easier to track changes and discuss proposals before you get started.
+
+1. Fork the repo and create a new branch from `main`.
+   - We suggest naming your branch `issue-##` if your pull request is addressing an open issue.
+2. Make your changes.
+   - If you've added code that should be tested, add tests.
+   - If you've changed APIs, update the documentation.
+3. Ensure the test suite passes and your code lints.
+4. Open the pull request!
+
+## Coding Style
+Be consistent with the coding style of the repository you are contributing to.
+Our projects generally have strict code formatters and linters which can fix basic style issues for you.
+
+## License
+Any contributions you make will be under the MIT Software License
+Feel free to contact the maintainers if that's a concern.
+
+## References
+This document was adapted from an [adaptation](https://gist.github.com/briandk/3d2e8b3ec8daf5a27a62) of the open-source contribution guidelines for [Facebook's Draft](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md).

.github/ISSUE_TEMPLATE/01_bug.yml

@@ -0,0 +1,42 @@
+name: Bug Report
+description: Report errors or unexpected results.
+labels: ["bug"]
+assignees:
+  - foobar-bug-assign-dev
+body:
+  - type: textarea
+    id: install
+    attributes:
+      label: How did you install foobar?
+      description: >
+        E.g., install via pip, install from source, etc. **Note:** this will
+        be rendered as console text automatically.
+      placeholder: |
+        $ pip install foobar
+        Collecting foobar
+        ...
+        Successfully installed foobar...
+      render: console
+    validations:
+      required: true
+
+  - type: input
+    id: version
+    attributes:
+      label: What version of foobar are you using?
+      description: >
+        Package version if installed via Pip or commit ID if installed
+        from source.
+      placeholder: v1.2.3
+    validations:
+      required: true
+
+  - type: textarea
+    id: freeform
+    attributes:
+      label: Describe the problem.
+      description: >
+        Please provide sample code and directions for reproducing
+        your problem and what you expected to happen.
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/02_enhancement.yml

@@ -0,0 +1,38 @@
+name: Enhancement Request
+description: Request a new feature or enhancement.
+labels: ["enhancement"]
+assignees:
+  - foobar-enh-assign-dev
+body:
+  - type: textarea
+    id: request
+    attributes:
+      label: Describe the Request
+      description: >
+        Please describe your use case and why the current feature set does
+        not satisfy your needs.
+    validations:
+      required: true
+
+  - type: textarea
+    id: example
+    attributes:
+      label: Sample Code
+      description: >
+        If relevant, please provide sample code such as the proposed
+        interface, usage, or results. **Note:** this will be rendered as
+        Python code automatically.
+      render: python
+    validations:
+      required: false
+
+  - type: textarea
+    id: additional
+    attributes:
+      label: Additional Code or Information
+      description: >
+        Optional space for additional code or text. **Note:** this will
+        be rendered as console text automatically.
+      render: console
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/03_docs.yml

@@ -0,0 +1,15 @@
+name: Documentation Improvements
+description: Suggest improvements to the documentation.
+labels: ["documentation"]
+assignees:
+  - foobar-doc-assignee-dev
+body:
+  - type: textarea
+    id: freeform
+    attributes:
+      label: Describe the Request
+      description: >
+        Please describe limitations of the current documentation or
+        suggested improvements.
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: true

.github/SECURITY.md

@@ -0,0 +1,14 @@
+# Security Policy
+
+## Supported Versions
+
+We currently only support the latest versions of the software with security
+updates. I.e., we will not backport new security updates to old versions.
+
+## Reporting a Vulnerability
+
+If you believe you have found a security vulnerability in the repository, we
+encourage you to let us know right away. We will investigate all legitimate
+reports and do our best to quickly fix the problem.
+
+Please report security issues to the Issue Tracker or Security Advisories.

.github/dependabot.yml

@@ -0,0 +1,8 @@
+version: 2
+
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      # Check for updates to GitHub Actions every week
+      interval: "weekly"

.github/pull_request_template.md

@@ -0,0 +1,34 @@
+# Description
+<!--- Describe your changes in detail --->
+
+
+### Fixes
+<!--- List any issue numbers above that this PR addresses --->
+
+- Fixes #XX
+- Fixes #XX
+
+### Type of Change
+<!--- Check which off the following types describe this PR --->
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Refactoring (internal implementation changes)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] Documentation update (no changes to the code)
+- [ ] CI change (changes to CI workflows, packages, templates, etc.)
+- [ ] Version changes (changes to the package or dependency versions)
+
+## Testing
+<!--- Please describe the test ran to verify changes --->
+
+N/A
+
+## Pull Request Checklist
+
+Please confirm the PR meets the following requirements.
+- [ ] Relevant tags are added (breaking, bug, dependencies, documentation, enhancement, refactor).
+- [ ] Code changes pass `pre-commit` (e.g., ruff, mypy, etc.).
+- [ ] Tests have been added to show the fix is effective or that the new feature works.
+- [ ] New and existing unit tests pass locally with the changes.
+- [ ] Docs have been updated and reviewed if relevant.

.github/release.yml

@@ -0,0 +1,45 @@
+changelog:
+  exclude:
+    labels:
+      - ignore-for-release
+    authors:
+      - pre-commit-ci
+  categories:
+    # Provide steps for upgrading the package and adjusting for
+    # breaking changes. No PRs included here.
+    - title: Upgrade Steps
+      exclude:
+        labels:
+          - "*"
+    # All PRs tagged as "breaking"
+    - title: Breaking Changes
+      labels:
+        - breaking
+    # All PRs tagged as "enhancement"
+    - title: New Features
+      labels:
+        - enhancement
+    # All PRs tagged as "bug"
+    - title: Bug Fixes
+      labels:
+        - bug
+    # All PRs not tagged as the above or below
+    - title: Improvements
+      labels:
+        - refactor
+      exclude:
+        labels:
+          - dependencies
+          - documentation
+    # All PRs tagged as documentation
+    - title: Improvements
+      labels:
+        - documentation
+    # All PRs tagged "dependencies"
+    - title: Dependencies
+      labels:
+        - dependencies
+    # All PRs not tagged as the above
+    - title: Other Changes
+      labels:
+        - "*"