Patch .copier-answers.yml at scaffops/python@9815413

Skeleton revision: https://github.com/bswck/skeleton/tree/9815413

.copier-answers.yml

@@ -1,7 +1,8 @@
 _commit: '9815413'
 _src_path: gh:bswck/skeleton
 author_username: bswck
-docs: false
+docs: true
+docs_slug: runtime-generics
 email_address: bswck.dev@gmail.com
 github_username: bswck
 license_name: MIT
@@ -17,4 +18,4 @@ python_version: '3.8'
 repo_name: runtime_generics
 test_suite: true
 use_precommit: true
-visibility: private
+visibility: public

.github/workflows/documentation-links.yml

@@ -0,0 +1,18 @@
+name: "readthedocs/actions"
+on:
+  pull_request_target:
+    types:
+    - "opened"
+    paths:
+    - "docs/**"
+
+permissions:
+  pull-requests: "write"
+
+jobs:
+  documentation-links:
+    runs-on: "ubuntu-latest"
+    steps:
+    - uses: "readthedocs/actions/preview@v1"
+      with:
+        project-slug: "runtime-generics"

.github/workflows/smokeshow.yml

@@ -0,0 +1,33 @@
+name: "Smokeshow"
+
+on:
+  workflow_run:
+    workflows: ["Tests"]
+    types: ["completed"]
+
+permissions:
+  actions: "read"
+  statuses: "write"
+
+jobs:
+  smokeshow:
+    runs-on: "ubuntu-latest"
+    environment: "Smokeshow"
+    steps:
+    - uses: "actions/setup-python@v4"
+      with:
+        python-version: "3.8"
+    - run: "pip install smokeshow"
+    - uses: "dawidd6/action-download-artifact@v2"
+      with:
+        workflow: "test.yml"
+        commit: "${{github.event.workflow_run.head_sha}}"
+    - run: "smokeshow upload coverage-html"
+      env:
+          SMOKESHOW_GITHUB_STATUS_DESCRIPTION: "Coverage {coverage-percentage}"
+          # 5 is set here while V2 is in development and coverage is far from complete
+          SMOKESHOW_GITHUB_COVERAGE_THRESHOLD: 91
+          SMOKESHOW_GITHUB_CONTEXT: "coverage"
+          SMOKESHOW_GITHUB_TOKEN: "${{secrets.GITHUB_TOKEN}}"
+          SMOKESHOW_GITHUB_PR_HEAD_SHA: "${{github.event.workflow_run.head_sha}}"
+          SMOKESHOW_AUTH_KEY: "${{secrets.SMOKESHOW_AUTH_KEY}}"

.readthedocs.yml

@@ -0,0 +1,14 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+version: 2
+mkdocs:
+  configuration: "mkdocs.yml"
+build:
+  os: "ubuntu-22.04"
+  tools:
+    python: "3.8"
+  jobs:
+    post_install:
+    - "pip install poetry"
+    - "poetry config virtualenvs.create false"
+    - "poetry install --with=docs"

CONTRIBUTING.md

@@ -0,0 +1,97 @@
+# Contributing to [runtime_generics](https://github.com/bswck/runtime_generics) 🎉
+Contributions are very welcome. 🚀
+
+There are many ways to contribute, ranging from **writing tutorials and improving the documentation**, to **submitting bug reports and feature requests or writing code** which can be **incorporated into runtime_generics**.
+
+## Report bugs and request features 🐛
+Report these in the [issue tracker](https://github.com/bswck/runtime_generics/issues).
+Relevant forms provide guidance on how to write a good bug report or feature request.
+
+## Implement new features ⭐
+[Look here](https://github.com/bswck/runtime_generics/issues?q=is%3Aopen+label%3Aenhancement+sort%3Aupdated-desc).
+Anything tagged with "enhancement" is open to whoever wants to implement it.
+
+## Write documentation 📖
+The project could always use more documentation, whether as part of the official project
+docs. If you're interested in helping out, check the [docs/](https://github.com/bswck/runtime_generics/tree/HEAD/docs) folder in the repository.
+
+## Share your feedback 🌍
+The best way to send feedback is to file an issue in the [issue tracker](https://github.com/bswck/runtime_generics).
+
+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? Here's a quick guide on how to set up runtime_generics and make a change.
+
+
+
+> [!Note]
+> If you use Windows, it is highly recommended to complete the installation in the way presented below through [WSL2](https://learn.microsoft.com/en-us/windows/wsl/install).
+
+
+
+1.  Fork the [runtime_generics repository](https://github.com/bswck/runtime_generics) on GitHub.
+
+1.  [Install Poetry](https://python-poetry.org/docs/#installation).<br/>
+    Poetry is an amazing tool for managing dependencies & virtual environments, building packages and publishing them.
+
+    ```shell
+    pipx install poetry
+    ```
+
+    <sub>If you encounter any problems, refer to [the official documentation](https://python-poetry.org/docs/#installation) for the most up-to-date installation instructions.</sub>
+
+    Be sure to have Python 3.8 installed—if you use [pyenv](https://github.com/pyenv/pyenv#readme), simply run:
+
+    ```shell
+    pyenv install 3.8
+    ```
+
+1.  Clone your fork locally and install dependencies.
+
+    ```shell
+    git clone https://github.com/your-username/runtime_generics path/to/runtime_generics
+    cd path/to/runtime_generics
+    poetry env use $(cat .python-version)
+    poetry install
+    poetry shell
+    pre-commit install --hook-type pre-commit --hook-type pre-push
+    ```
+
+
+1.  Create a branch for local development:
+
+    ```shell
+    git checkout -b name-of-your-bugfix-or-feature
+    ```
+
+    Now you can make your changes locally.
+
+1.  When you're done making changes, check that your changes pass all tests:
+
+    ```shell
+    poe check
+    ```
+
+1.  Commit your changes and push your branch to GitHub:
+
+    ```shell
+    git add .
+    git commit -m "Short description of changes (50 chars max)" -m "Optional extended description"
+    git push origin name-of-your-bugfix-or-feature
+    ```
+
+1.  Submit a pull request through the GitHub website.
+
+
+## Pull Request guidelines 📝
+1. Initially mark the PR as a draft, so that the maintainers know that you are making final touches.
+2. Ensure that the [test coverage](https://coverage-badge.samuelcolvin.workers.dev/redirect/bswck/runtime_generics) is not decreased. If you add a new feature, please add tests for it. [Read more about coverage](https://coverage.readthedocs.io/en/latest/index.html).
+3. Ensure that all GitHub checks pass. If they are disabled in your PR, ping the maintainers to request enabling them.
+4. Don't forget to link the relevant issue(s) in the PR description and describe the changes you made.

README.md

@@ -1,8 +1,10 @@
 
 # runtime_generics [![Package version](https://img.shields.io/pypi/v/runtime-generics?label=PyPI)](https://pypi.org/project/runtime-generics/) [![Supported Python versions](https://img.shields.io/pypi/pyversions/runtime-generics.svg?logo=python&label=Python)](https://pypi.org/project/runtime-generics/)
 [![Tests](https://github.com/bswck/runtime_generics/actions/workflows/test.yml/badge.svg)](https://github.com/bswck/runtime_generics/actions/workflows/test.yml)
+[![Coverage](https://coverage-badge.samuelcolvin.workers.dev/bswck/runtime_generics.svg)](https://coverage-badge.samuelcolvin.workers.dev/redirect/bswck/runtime_generics)
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 [![Code style](https://img.shields.io/badge/code%20style-black-000000.svg?label=Code%20style)](https://github.com/psf/black)
+[![License](https://img.shields.io/github/license/bswck/runtime_generics.svg?label=License)](https://github.com/bswck/runtime_generics/blob/HEAD/LICENSE)
 [![Pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
 
 Highly into type-safe Python code?
@@ -91,6 +93,7 @@ poetry add runtime-generics
 
 
 
+1.  Fork the [runtime_generics repository](https://github.com/bswck/runtime_generics) on GitHub.
 
 1.  [Install Poetry](https://python-poetry.org/docs/#installation).<br/>
     Poetry is an amazing tool for managing dependencies & virtual environments, building packages and publishing them.
@@ -107,19 +110,20 @@ poetry add runtime-generics
     pyenv install 3.8
     ```
 
-1.  Make sure you have the contributor access.
-
-1.  Clone this repository locally and install dependencies.
+1.  Clone your fork locally and install dependencies.
 
     ```shell
-    git clone https://github.com/bswck/runtime_generics path/to/runtime_generics
+    git clone https://github.com/your-username/runtime_generics path/to/runtime_generics
     cd path/to/runtime_generics
     poetry env use $(cat .python-version)
     poetry install
     poetry shell
     pre-commit install --hook-type pre-commit --hook-type pre-push
     ```
 
+For more information on how to contribute, check out [CONTRIBUTING.md](https://github.com/bswck/runtime_generics/blob/HEAD/CONTRIBUTING.md).<br/>
+Always happy to accept contributions! ❤️
+
 
 # Legal info
 © Copyright by Bartosz Sławecki ([@bswck](https://github.com/bswck)).

docs/changelog.md

@@ -0,0 +1 @@
+../CHANGELOG.md

docs/contributing.md

@@ -0,0 +1,98 @@
+
+# Contributing to [runtime_generics](https://github.com/bswck/runtime_generics) 🎉
+Contributions are very welcome. 🚀
+
+There are many ways to contribute, ranging from **writing tutorials and improving the documentation**, to **submitting bug reports and feature requests or writing code** which can be **incorporated into runtime_generics**.
+
+## Report bugs and request features 🐛
+Report these in the [issue tracker](https://github.com/bswck/runtime_generics/issues).
+Relevant forms provide guidance on how to write a good bug report or feature request.
+
+## Implement new features ⭐
+[Look here](https://github.com/bswck/runtime_generics/issues?q=is%3Aopen+label%3Aenhancement+sort%3Aupdated-desc).
+Anything tagged with "enhancement" is open to whoever wants to implement it.
+
+## Write documentation 📖
+The project could always use more documentation, whether as part of the official project
+docs. If you're interested in helping out, check the [docs/](https://github.com/bswck/runtime_generics/tree/HEAD/docs) folder in the repository.
+
+## Share your feedback 🌍
+The best way to send feedback is to file an issue in the [issue tracker](https://github.com/bswck/runtime_generics).
+
+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? Here's a quick guide on how to set up runtime_generics and make a change.
+
+
+
+!!! Note
+    If you use Windows, it is highly recommended to complete the installation in the way presented below through [WSL2](https://learn.microsoft.com/en-us/windows/wsl/install).
+
+
+
+1.  Fork the [runtime_generics repository](https://github.com/bswck/runtime_generics) on GitHub.
+
+1.  [Install Poetry](https://python-poetry.org/docs/#installation).<br/>
+    Poetry is an amazing tool for managing dependencies & virtual environments, building packages and publishing them.
+
+    ```shell
+    pipx install poetry
+    ```
+
+    <sub>If you encounter any problems, refer to [the official documentation](https://python-poetry.org/docs/#installation) for the most up-to-date installation instructions.</sub>
+
+    Be sure to have Python 3.8 installed—if you use [pyenv](https://github.com/pyenv/pyenv#readme), simply run:
+
+    ```shell
+    pyenv install 3.8
+    ```
+
+1.  Clone your fork locally and install dependencies.
+
+    ```shell
+    git clone https://github.com/your-username/runtime_generics path/to/runtime_generics
+    cd path/to/runtime_generics
+    poetry env use $(cat .python-version)
+    poetry install
+    poetry shell
+    pre-commit install --hook-type pre-commit --hook-type pre-push
+    ```
+
+
+1.  Create a branch for local development:
+
+    ```shell
+    git checkout -b name-of-your-bugfix-or-feature
+    ```
+
+    Now you can make your changes locally.
+
+1.  When you're done making changes, check that your changes pass all tests:
+
+    ```shell
+    poe check
+    ```
+
+1.  Commit your changes and push your branch to GitHub:
+
+    ```shell
+    git add .
+    git commit -m "Short description of changes (50 chars max)" -m "Optional extended description"
+    git push origin name-of-your-bugfix-or-feature
+    ```
+
+1.  Submit a pull request through the GitHub website.
+
+
+## Pull Request guidelines 📝
+1. Initially mark the PR as a draft, so that the maintainers know that you are making final touches.
+2. Ensure that the [test coverage](https://coverage-badge.samuelcolvin.workers.dev/redirect/bswck/runtime_generics) is not decreased. If you add a new feature, please add tests for it. [Read more about coverage](https://coverage.readthedocs.io/en/latest/index.html).
+3. Ensure that all GitHub checks pass. If they are disabled in your PR, ping the maintainers to request enabling them.
+4. Don't forget to link the relevant issue(s) in the PR description and describe the changes you made.