munich-quantum-toolkit / munich-quantum-toolkit/templates

✨ Use templating for more files

Open
#2 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feature
Dominant language
Python
Stars
3
Forks
3
Avg merge
4h 4m
Merged PRs (30d)
49

Description

As for files that would make sense to incorporate as part of the templating, I started to collect a small list (could be transformed to a task list in an issue of the new repository):

  • .github/SECURITY.md
  • .github/support.md
  • .github/contributing.md
  • .github/release-drafter.yml
  • .github/renovate.json5
  • .github/codecov.yml (not 100% sure since there are quite some special cases here across repos. the core is still the same)
  • .github/pull_request_template.md
  • .github/ISSUE_TEMPLATE/bug-report.yml
  • .github/ISSUE_TEMPLATE/feature-request.yml
  • .github/workflows/ci.yml
  • .github/workflows/cd.yml
  • .github/workflows/release-drafter.yml
  • .github/workflows/upstream.yml
  • .github/workflows/update-mqt-core.yml
  • docs/_static/custom.css
  • docs/_templates/page.html
  • docs/development_guide.md (will take a bit of effort to properly template)
  • docs/installation.md (not 100% sure, but could be nice)
  • docs/lit_header.bib
  • .clang-format
  • .clang-tidy
  • .cmake-format.yaml
  • .git_archival.txt
  • .gitignore (huge overlap between all repos)
  • .license-tools-config.json
  • .pre-commit-config.yaml (not 100% straightforward to template because of, e.g., mypy dependencies)
  • README.md (don't know if there is too much value here. certain sections and the overall structure should be the same across all repositories)
  • noxfile.py (differs for pure-Python and C++-Python projects)
  • ruff.toml (if we should decide to add that in favor of keeping the config in pyproject.toml to make it easier to template)
  • uv.toml (same as ruff.toml)
  • (further ideas. mypy config, codecov config, ...)

Originally posted by @burgholzer in https://github.com/munich-quantum-toolkit/.github/pull/44#pullrequestreview-2943933347

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the candidate paths listed in the issue, along with the original .github pull request review that proposed them. Determine which files can be incorporated into the repository’s templating and account for noted special cases such as pure-Python versus C++-Python projects. Done means the selected files are represented by the templating system across repositories.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, python
Domain
devops, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.