chore: init

.editorconfig

@@ -0,0 +1,15 @@
+# editorconfig
+# Ref: https://editorconfig.org
+# ------------------------------------------------------------------------------
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 2
+trim_trailing_whitespace = true
+
+[*.{py,pyi}]
+indent_size = 4

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,112 @@
+# 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 [@afuetterer](https://github.com/afuetterer).
+
+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 [cookiecutter-hypermodern-python (MIT License)][hypermodern-python-coc].*
+
+The cookiecutter-hypermodern-python version is originally 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].
+
+<!-- Markdown links -->
+
+[faq]: https://www.contributor-covenant.org/faq
+[homepage]: https://www.contributor-covenant.org
+[hypermodern-python-coc]: https://github.com/cjolowicz/cookiecutter-hypermodern-python/blob/main/%7B%7Bcookiecutter.project_name%7D%7D/CODE_OF_CONDUCT.md
+[mozilla coc]: https://github.com/mozilla/diversity
+[translations]: https://www.contributor-covenant.org/translations
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html

.github/CONTRIBUTING.md

@@ -0,0 +1,122 @@
+# Contributing to python-re3data
+
+Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
+
+You can contribute in many ways.
+
+## Types of Contributions
+
+### Report Bugs
+
+Report bugs at <https://github.com/afuetterer/python-re3data/issues>.
+
+If you are reporting a bug, please include:
+
+- Your operating system name and version.
+- Any details about your local setup that might be helpful in troubleshooting.
+- Detailed steps to reproduce the bug.
+
+### Fix Bugs
+
+Look through the GitHub issues for bugs. Anything tagged with [bug and help wanted][bug-issues-help-wanted] is open to
+whoever wants to implement it.
+
+### Implement Features
+
+Look through the GitHub issues for features. Anything tagged with [feature and help wanted][feature-issues-help-wanted]
+is open to whoever wants to implement it.
+
+### Write Documentation
+
+`python-re3data` could always use more documentation, whether as part of the official `python-re3data` docs, in
+docstrings, or even on the web in blog posts, articles, and such.
+
+### Submit Feedback
+
+The best way to send feedback is to file an issue at https://github.com/afuetterer/python-re3data/issues.
+
+If you are proposing a feature:
+
+- Explain in detail how it would work.
+- Keep the scope as narrow as possible, to make it easier to implement.
+- Remember that this is a volunteer-driven project, and that contributions are welcome.
+
+## Get Started!
+
+Ready to contribute?
+
+You need Python >= 3.10 and [hatch](https://github.com/pypa/hatch). You can install it globally with
+[pipx](https://github.com/pypa/pipx):
+
+```console
+$ pipx install hatch
+```
+
+or locally with (this will install it in the local virtual environment):
+
+```console
+$ python -m pip install hatch
+```
+
+Here's how to set up `python-re3data` for local development.
+
+1. Fork the python-re3data repository on GitHub.
+
+2. Clone your fork locally:
+
+    ```console
+    $ git clone [email protected]:username/python-re3data.git
+    ```
+
+3. Install your local copy into a virtual environment. Assuming you have hatch installed, this is how you set up your
+    fork for local development:
+
+    ```console
+    $ cd python-re3data
+    $ hatch shell
+    ```
+
+4. Create a branch for local development:
+
+    ```console
+    $ git checkout -b name-of-your-bugfix-or-feature
+    ```
+
+    Now you can make your changes locally.
+
+5. When you're done making changes, check that your changes pass pre-commit and the tests:
+
+    ```console
+    $ hatch run check
+    $ hatch run cov
+    ```
+
+6. Commit your changes and push your branch to GitHub::
+
+    ```console
+    $ git add .
+    $ git commit -m "Your detailed description of your changes."
+    $ git push origin name-of-your-bugfix-or-feature
+    ```
+
+7. Submit a pull request through the GitHub website.
+
+## Pull Request Guidelines
+
+Before you submit a pull request, check that it meets these guidelines:
+
+1. The pull request should include tests.
+2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a
+    docstring.
+3. The pull request should work for Python >= 3.10. Check <https://github.com/afuetterer/python-re3data/pulls> and make
+    sure that all the tests pass.
+
+---
+
+*This contributor guide is adapted from
+[cookiecutter-pypackage (BSD 3-Clause License)](https://github.com/audreyfeldroy/cookiecutter-pypackage/blob/master/%7B%7Bcookiecutter.project_slug%7D%7D/CONTRIBUTING.rst).*
+
+<!-- Refs -->
+
+[bug-issues-help-wanted]: https://github.com/afuetterer/python-re3data/issues?q=is%3Aissue+is%3Aopen+label%3A%22type%3A+bug%22+label%3A%22help+wanted%22
+[feature-issues-help-wanted]: https://github.com/afuetterer/python-re3data/issues?q=is%3Aissue+is%3Aopen+label%3A%22type%3A+feature%22+label%3A%22help+wanted%22

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,51 @@
+---
+name: Bug report
+about: Create a bug report to help us improve
+labels: ['type: bug']
+---
+
+<!--- Provide a general summary of the issue in the Title above --->
+
+## Description
+
+<!--- Provide a more detailed introduction to the issue itself, and why you consider it to be a bug --->
+
+## Expected Behavior
+
+<!--- Tell us what should happen --->
+
+## Actual Behavior
+
+<!--- Tell us what happens instead --->
+
+## Possible Fix
+
+<!--- Not obligatory, but suggest a fix or reason for the bug --->
+
+## Steps to reproduce
+
+<!---
+Provide a link to a live example, or an unambiguous set of steps to
+reproduce this bug. Include code to reproduce, if relevant
+--->
+
+1.
+2.
+3.
+
+## Additional Context
+
+<!--- How has this bug affected you? What were you trying to accomplish? --->
+
+## Your Environment
+
+<!--- Please provide the output of the following commands. --->
+
+- Python version used (`python --version`):
+- python-re3data version used (`python -m pip show python-re3data | grep "^Version:"`):
+- Operating system and version:
+
+<!---
+This issue template is adapted from:
+"open-source-templates", https://github.com/TalAter/open-source-templates (MIT License).
+--->

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,24 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+labels: ['type: feature']
+---
+
+<!--- Provide a general summary of the issue in the Title above -->
+
+## Detailed Description
+
+<!--- Provide a detailed description of the change or addition you are proposing -->
+
+## Context
+
+<!--- Why is this change important to you? How would you use it? -->
+
+<!--- How can it benefit other users? -->
+
+## Possible Implementation
+
+<!--- Not obligatory, but suggest an idea for implementing addition or change -->
+
+<!--- This issue template is adapted from:
+<!--- "open-source-templates", https://github.com/TalAter/open-source-templates (MIT License). --->

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,64 @@
+<!-- These comments are hidden when you submit the pull request, so you do not need to remove them. --->
+
+<!--- Provide a general summary of your changes in the Title above --->
+
+## Description
+
+<!---
+Describe your changes in detail
+
+This project only accepts pull requests related to open issues
+If suggesting a new feature or change, please discuss it in an issue first
+If fixing a bug, there should be an issue describing it with steps to reproduce
+Please link to the issue here:
+--->
+
+Related issue: #ISSUE_NUMBER
+
+## 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.
+
+Include details of your testing environment, and the tests you ran to
+see how your change affects other areas of the code, etc.
+--->
+
+## Types of changes
+
+<!--- What types of changes does your code introduce? Remove the lines, that do not apply. --->
+
+- Breaking change (fix or feature that would cause existing functionality to change)
+- New feature (non-breaking change which adds functionality)
+- Bug fix (non-breaking change which fixes an issue)
+- Refactoring (no functional changes, no API changes)
+- Performance (improves performance)
+- Test (adding new tests or correcting existing tests)
+- Code style (formatting, renaming)
+- Documentation content changes
+- Build related changes
+- Continuous Integration changes (e.g. GitHub actions, Dependabot)
+- Other (please describe):
+
+## Checklist
+
+<!---
+Go over all the following points, and remove the lines, that do not apply.
+If you're unsure about any of these, don't hesitate to ask. We're here to help!
+--->
+
+- I have read the [contributor guide](https://github.com/afuetterer/python-re3data/blob/main/.github/CONTRIBUTING.md).
+- My code follows the code style of this project.
+- My change requires a change to the documentation.
+- I have updated the documentation accordingly.
+- I have added tests to cover my changes.
+
+<!---
+This pull request template is adapted from:
+"open-source-templates", https://github.com/TalAter/open-source-templates (MIT License).
+"amazing-github-template", https://github.com/dec0dOS/amazing-github-template (MIT License).
+--->