Merge branch 'release/0.4.0'

.github/workflows/ci.yml

@@ -25,7 +25,7 @@ jobs:
 
       - uses: actions/setup-python@v5
         with:
-          python-version: "3.12"
+          python-version: "3.10"
           cache: poetry
 
       - name: poetry check
@@ -43,14 +43,20 @@ jobs:
       - name: basedpyright
         run: poetry run basedpyright
 
+      - name: markdownlint
+        uses: DavidAnson/markdownlint-cli2-action@v16
+        with:
+          config: '.markdownlint.jsonc'
+          globs: '**/*.md'
+
   test:
     timeout-minutes: 5
 
     strategy:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
-        python-version: ["3.12"]
+        python-version: ["3.10", "3.11", "3.12", "3.13-dev"]
 
     runs-on: ${{ matrix.os }}
 

.markdownlint.jsonc

@@ -3,6 +3,9 @@
   "MD007": {
     "indent": 4
   },
+  "MD013": {
+    "line_length": 79
+  },
   "MD033": {
     "allowed_elements": [
       "h1",

.pre-commit-config.yaml

@@ -16,13 +16,13 @@ repos:
       - id: codespell
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.3.5
+    rev: v0.3.7
     hooks:
       - id: ruff
         args: [--fix, --exit-non-zero-on-fix]
 
   - repo: https://github.com/DetachHead/basedpyright
-    rev: b1ebff9e96a087851fc24efe1674660cfea59140
+    rev: v1.10.1
     hooks:
       - id: basedpyright
 

CODE_OF_CONDUCT.md

@@ -0,0 +1,70 @@
+# Code of Conduct - optype
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to make participation in our project and
+our community a harassment-free experience for everyone, regardless of age,
+body size, 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.
+
+## 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
+- 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
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying and enforcing our standards
+of acceptable behavior and will take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban
+temporarily or permanently any contributor for other behaviors that they deem
+inappropriate, threatening, offensive, or harmful.
+
+## 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
+`jhammudoglu<at>gmail<dot>com`
+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.
+
+## Attribution
+
+This Code of Conduct is adapted from the
+[Contributor Covenant](https://contributor-covenant.org/) and was generated by
+[contributing-gen](https://github.com/bttger/contributing-gen).

CONTRIBUTING.md

@@ -0,0 +1,246 @@
+<!-- omit in toc -->
+# Contributing to optype
+
+First off, thanks for taking the time to contribute! ❤️
+
+All types of contributions are encouraged and valued.
+See the [Table of Contents](#table-of-contents) for different ways to help and
+details about how this project handles them.
+Please make sure to read the relevant section before making your contribution.
+It will make it a lot easier for us maintainers and smooth out the experience
+for all involved.
+The community looks forward to your contributions. 🎉
+
+> [!NOTE]
+> And if you like optype, but just don't have time to contribute, that's fine.
+> There are other easy ways to support the project and show your appreciation,
+> which we would also be very happy about:
+>
+> - Star the project
+> - Tweet about it
+> - Refer this project in your project's readme
+> - Mention the project at local meetups and tell your friends/colleagues
+
+<!-- omit in toc -->
+## Table of Contents
+
+- [Code of Conduct](#code-of-conduct)
+- [I Have a Question](#i-have-a-question)
+- [I Want To Contribute](#i-want-to-contribute)
+    - [Reporting Bugs](#reporting-bugs)
+    - [Suggesting Enhancements](#suggesting-enhancements)
+    - [Your First Code Contribution](#your-first-code-contribution)
+    - [Improving The Documentation](#improving-the-documentation)
+
+## Code of Conduct
+
+This project and everyone participating in it is governed by the
+[optype Code of Conduct][COC].
+By participating, you are expected to uphold this code.
+Please report unacceptable behavior to `jhammudoglu<at>gmail<dot>com`.
+
+## I Have a Question
+
+> [!NOTE]
+> If you want to ask a question, we assume that you have read the
+> available [Documentation][DOC].
+
+Before you ask a question, it is best to search for existing [Issues][BUG]
+that might help you.
+In case you have found a suitable issue and still need clarification,
+you can write your question in this issue.
+It is also advisable to search the internet for answers first.
+
+If you then still feel the need to ask a question and need clarification, we
+recommend the following:
+
+- Open an [Issue][BUG].
+- Provide as much context as you can about what you're running into.
+- Provide project and platform versions (Python, mypy, pyright, ruff, etc),
+depending on what seems relevant.
+
+We will then take care of the issue as soon as possible.
+
+## I Want To Contribute
+
+> ### Legal Notice <!-- omit in toc -->
+>
+> When contributing to this project,
+> you must agree that you have authored 100% of the content,
+> that you have the necessary rights to the content and that the content you
+> contribute may be provided under the project license.
+
+### Reporting Bugs
+
+<!-- omit in toc -->
+#### Before Submitting a Bug Report
+
+A good bug report shouldn't leave others needing to chase you up for more
+information.
+Therefore, we ask you to investigate carefully, collect information and
+describe the issue in detail in your report.
+Please complete the following steps in advance to help us fix any potential
+bug as fast as possible.
+
+- Make sure that you are using the latest version.
+- Determine if your bug is really a bug and not an error on your side e.g.
+using incompatible environment components/versions
+(Make sure that you have read the [documentation][DOC].
+If you are looking for support, you might want to check
+[this section](#i-have-a-question)).
+- To see if other users have experienced (and potentially already solved)
+the same issue you are having, check if there is not already a bug report
+existing for your bug or error in the [bug tracker][BUG].
+- Also make sure to search the internet (including Stack Overflow) to see if
+users outside of the GitHub community have discussed the issue.
+- Collect information about the bug:
+    - Stack trace (Traceback)
+    - OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
+    - Version of the interpreter, compiler, SDK, runtime environment,
+    package manager, depending on what seems relevant.
+    - Possibly your input and the output
+    - Can you reliably reproduce the issue?
+    And can you also reproduce it with older versions?
+
+<!-- omit in toc -->
+#### How Do I Submit a Good Bug Report?
+
+> You must never report security related issues, vulnerabilities or bugs
+including sensitive information to the issue tracker, or elsewhere in public.
+Instead sensitive bugs must be sent by email to `jhammudoglu<at>gmail<dot>com`.
+
+We use GitHub issues to track bugs and errors.
+If you run into an issue with the project:
+
+- Open an [Issue][BUG].
+(Since we can't be sure at this point whether it is a bug or not,
+we ask you not to talk about a bug yet and not to label the issue.)
+- Explain the behavior you would expect and the actual behavior.
+- Please provide as much context as possible and describe the
+*reproduction steps* that someone else can follow to recreate the issue on
+their own.
+This usually includes your code.
+For good bug reports you should isolate the problem and create a reduced test
+case.
+- Provide the information you collected in the previous section.
+
+Once it's filed:
+
+- The project team will label the issue accordingly.
+- A team member will try to reproduce the issue with your provided steps.
+If there are no reproduction steps or no obvious way to reproduce the issue,
+the team will ask you for those steps and mark the issue as `needs-repro`.
+Bugs with the `needs-repro` tag will not be addressed until they are
+reproduced.
+- If the team is able to reproduce the issue, it will be marked `needs-fix`,
+as well as possibly other tags (such as `critical`), and the issue will be
+left to be [implemented by someone](#your-first-code-contribution).
+
+### Suggesting Enhancements
+
+This section guides you through submitting an enhancement suggestion for
+optype, **including completely new features and minor improvements to existing
+functionality**.
+Following these guidelines will help maintainers and the community to
+understand your suggestion and find related suggestions.
+
+<!-- omit in toc -->
+#### Before Submitting an Enhancement
+
+- Make sure that you are using the latest version.
+- Read the [documentation][DOC] carefully and find out if the functionality is
+already covered, maybe by an individual configuration.
+- Perform a [search][BUG] to see if the enhancement has already been suggested.
+If it has, add a comment to the existing issue instead of opening a new one.
+- Find out whether your idea fits with the scope and aims of the project.
+It's up to you to make a strong case to convince the project's developers of
+the merits of this feature. Keep in mind that we want features that will be
+useful to the majority of our users and not just a small subset. If you're
+just targeting a minority of users, consider writing an add-on/plugin library.
+
+<!-- omit in toc -->
+#### How Do I Submit a Good Enhancement Suggestion?
+
+Enhancement suggestions are tracked as [GitHub issues][BUG].
+
+- Use a **clear and descriptive title** for the issue to identify the
+suggestion.
+- Provide a **step-by-step description of the suggested enhancement** in as
+many details as possible.
+- **Describe the current behavior** and **explain which behavior you expected
+to see instead** and why. At this point you can also tell which alternatives
+do not work for you.
+- **Explain why this enhancement would be useful** to most optype users.
+You may also want to point out the other projects that solved it better and
+which could serve as inspiration.
+
+### Your First Code Contribution
+
+Ensure you have [poetry](https://python-poetry.org/docs/#installation)
+installed.
+It can help to use optype's lowest-supported Python version, so that you don't
+accidentally use those bleeding-edge Python features that you shouldn't, e.g.
+
+```bash
+poetry env use python3.11
+```
+
+Now you can install the dev dependencies using
+
+```bash
+poetry install --sync
+```
+
+### pre-commit
+
+Optype uses [pre-commit](https://pre-commit.com/) to ensure that the code is
+formatted and typed correctly when committing the changes.
+
+```bash
+poetry run pre-commit install
+```
+
+It can also be manually run:
+
+```bash
+poetry run pre-commit run --all-files
+```
+
+This is roughly the same as manually running
+
+```bash
+poetry check
+poetry run codespell
+poetry run ruff --fix
+poetry run basedpyright
+poetry run markdownlint
+```
+
+> [!NOTE]
+> Pre-commit doesn't run the tests. This will be run by github actions when
+> submitting a pull request. See the next section for more details.
+
+### Testing
+
+Optype uses [pytest](https://docs.pytest.org/en/stable/) for unit testing.
+These tests can be run with
+
+```bash
+poetry run pytest
+```
+
+### Improving The Documentation
+
+All [documentation] lives in the `README.md`. Please read it carefully before
+proposing any changes. Ensure that the markdown is formatted correctly with
+[markdownlint](https://github.com/DavidAnson/markdownlint/tree/main).
+
+<!-- omit in toc -->
+## Attribution
+
+This guide is based on the **contributing-gen**.
+[Make your own](https://github.com/bttger/contributing-gen)!
+
+[BUG]: https://github.com/jorenham/optype/issues
+[COC]: https://github.com/jorenham/optype/blob/master/CODE_OF_CONDUCT.md
+[DOC]: https://github.com/jorenham/optype?tab=readme-ov-file#optype