From bfe715ee0935b43615b9833f8a3a94c012c155f2 Mon Sep 17 00:00:00 2001 From: Lerking <1+lerking@noreply.localhost> Date: Wed, 26 Aug 2026 12:35:53 +0200 Subject: [PATCH 1/7] Upload files to "wiki" --- wiki/Architecture.md | 35 +++++++++++++++++++++++++++++++++ wiki/FAQ.md | 10 ++++++++++ wiki/Getting-Started.md | 37 +++++++++++++++++++++++++++++++++++ wiki/Project-Specification.md | 28 ++++++++++++++++++++++++++ wiki/Value-Stream-Mapping.md | 37 +++++++++++++++++++++++++++++++++++ 5 files changed, 147 insertions(+) create mode 100644 wiki/Architecture.md create mode 100644 wiki/FAQ.md create mode 100644 wiki/Getting-Started.md create mode 100644 wiki/Project-Specification.md create mode 100644 wiki/Value-Stream-Mapping.md diff --git a/wiki/Architecture.md b/wiki/Architecture.md new file mode 100644 index 0000000..493bd12 --- /dev/null +++ b/wiki/Architecture.md @@ -0,0 +1,35 @@ +# Architecture + +> Keep this page in sync with the "Architecture & Design" section of the project +> specification. The specification captures the *decision*; this page captures the +> *current, evolving state* of the system for people working in the codebase day to day. + +## Overview + +One paragraph: what the major pieces are and how they fit together. Include or link a +diagram. + +## Components + +| Component | Responsibility | Depends on | +|---|---|---| +| | | | + +## Data flow + +Describe how data moves through the system, from input to output. + +## External dependencies + +| Dependency | Purpose | Notes | +|---|---|---| +| | | | + +## Key design decisions + +A short log of significant decisions and the reasoning behind them (an ADR-style list is +fine here if you don't have a separate `docs/adr/` folder). + +| Decision | Date | Reasoning | +|---|---|---| +| | | | diff --git a/wiki/FAQ.md b/wiki/FAQ.md new file mode 100644 index 0000000..abf9b56 --- /dev/null +++ b/wiki/FAQ.md @@ -0,0 +1,10 @@ +# FAQ + +> A running list of questions that came up more than once. If you find yourself answering +> the same question in an issue or chat, add it here. + +**Q: ``** +A: `` + +**Q: ``** +A: `` diff --git a/wiki/Getting-Started.md b/wiki/Getting-Started.md new file mode 100644 index 0000000..f4e1765 --- /dev/null +++ b/wiki/Getting-Started.md @@ -0,0 +1,37 @@ +# Getting Started + +## Prerequisites + +- Python `` +- `` + +## Installation + +```bash +git clone +cd + +``` + +## Configuration + +- Environment variables / config file(s) needed, and where to get their values +- Any secrets or credentials required, and how to obtain them safely (never commit them) + +## Running the project + +```bash + +``` + +## Running the tests + +```bash + +``` + +## Common issues + +| Symptom | Cause | Fix | +|---|---|---| +| | | | diff --git a/wiki/Project-Specification.md b/wiki/Project-Specification.md new file mode 100644 index 0000000..fb0c529 --- /dev/null +++ b/wiki/Project-Specification.md @@ -0,0 +1,28 @@ +# Project Specification + +The authoritative project specification lives in +[`docs/PROJECT_SPECIFICATION.md`](../docs/PROJECT_SPECIFICATION_TEMPLATE.md) (based on the +[project specification template](../docs/PROJECT_SPECIFICATION_TEMPLATE.md)), not on this +wiki page — it needs version control and review history that the wiki doesn't give you. + +This page exists so the specification is easy to find. Keep it updated with: + +- **Current version:** `` +- **Status:** Draft / In Review / Approved +- **Last approved:** `` + +## Summary + +Paste the 3–5 sentence summary from Section 1 of the specification here, so readers get the +gist without leaving the wiki. + +## Key goals + +- Goal 1 +- Goal 2 +- Goal 3 + +## Notable non-goals + +- Non-goal 1 +- Non-goal 2 diff --git a/wiki/Value-Stream-Mapping.md b/wiki/Value-Stream-Mapping.md new file mode 100644 index 0000000..544a744 --- /dev/null +++ b/wiki/Value-Stream-Mapping.md @@ -0,0 +1,37 @@ +# Value Stream Mapping + +The current and future state value stream maps live in +[`docs/value-stream-mapping/`](../docs/value-stream-mapping/) as an OpenDocument +Presentation (`.odp`), editable in LibreOffice Impress, OpenOffice Impress, or (with +conversion) PowerPoint/Google Slides. + +## Current state summary + +Briefly describe the current process, its main bottlenecks, and the headline metrics +(total lead time, total cycle time, %C&A) once the current state map is complete. + +| Metric | Value | +|---|---| +| Total lead time | | +| Total cycle time (value-added time) | | +| Process cycle efficiency | | + +## Future state summary + +Briefly describe the target process and what changes once the future state map is +complete. + +| Metric | Value | +|---|---| +| Target lead time | | +| Target cycle time | | +| Target process cycle efficiency | | + +## Improvement actions + +Pulled from the action plan slide in the map — kept here for visibility, updated from the +`.odp` file when it changes. + +| Action | Owner | Due | Status | +|---|---|---|---| +| | | | | -- 2.39.5 From 009a16eec3bcb88d1dce66fae887d6ec9b48bc0e Mon Sep 17 00:00:00 2001 From: Lerking <1+lerking@noreply.localhost> Date: Wed, 26 Aug 2026 12:36:11 +0200 Subject: [PATCH 2/7] Upload files to "wiki" --- wiki/Home.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 wiki/Home.md diff --git a/wiki/Home.md b/wiki/Home.md new file mode 100644 index 0000000..6973885 --- /dev/null +++ b/wiki/Home.md @@ -0,0 +1,33 @@ +# Wiki + +> Copy the pages in this `wiki/` folder into your repository's actual GitHub Wiki (or your +> wiki tool of choice), then fill them in. File names map to page titles, so keep them as-is +> unless you're renaming the page. Delete this note once the wiki is populated. + +Welcome. This wiki is the living documentation for the project — the specification and value +stream map describe what we set out to build and why; this wiki describes how the project +actually works and how to use it, day to day. + +## Pages + +- **[[Getting Started]]** — install, configure, and run the project locally +- **[[Architecture]]** — how the system is put together and why +- **[[Project Specification]]** — link/summary of the approved specification +- **[[Value Stream Mapping]]** — link/summary of the current & future state maps +- **[[FAQ]]** — common questions and troubleshooting + +## Quick links + +| | | +|---|---| +| Repository | `` | +| Issue tracker | `` | +| Project specification | [docs/PROJECT_SPECIFICATION.md](../docs/PROJECT_SPECIFICATION_TEMPLATE.md) | +| Value stream map | [docs/value-stream-mapping/](../docs/value-stream-mapping/) | +| CI / build status | `` | + +## Conventions + +- Branching model: `` +- Commit message style: `` +- Where decisions get recorded: `` -- 2.39.5 From 60cf3e26e03189abbebeafb471ea148758118123 Mon Sep 17 00:00:00 2001 From: Lerking <1+lerking@noreply.localhost> Date: Wed, 26 Aug 2026 12:36:46 +0200 Subject: [PATCH 3/7] Upload files to "docs" --- docs/NEW_PROJECT_CHECKLIST.md | 64 ++++++++++ docs/PROJECT_SPECIFICATION_TEMPLATE.md | 155 +++++++++++++++++++++++++ 2 files changed, 219 insertions(+) create mode 100644 docs/NEW_PROJECT_CHECKLIST.md create mode 100644 docs/PROJECT_SPECIFICATION_TEMPLATE.md diff --git a/docs/NEW_PROJECT_CHECKLIST.md b/docs/NEW_PROJECT_CHECKLIST.md new file mode 100644 index 0000000..f7a9dc1 --- /dev/null +++ b/docs/NEW_PROJECT_CHECKLIST.md @@ -0,0 +1,64 @@ +# New Project Checklist + +Work through this checklist when setting up a new project from this template. It's ordered +roughly in the sequence you'd actually do the work, but feel free to skip items that don't +apply and add project-specific ones at the bottom. + +## 1. Repository setup + +- [ ] Create the repository from this template +- [ ] Rename the project (repo name, `main.py` header, README title) +- [ ] Update `LICENCE` copyright holder and year +- [ ] Review `.gitignore` for anything project-specific to add (env files, build artefacts, data dumps) +- [ ] Set repository visibility (public/private) and default branch protections +- [ ] Add collaborators / team access +- [ ] Update README badges (or remove the ones that don't apply) +- [ ] Enable the wiki and publish the [wiki template](../wiki/Home.md) pages + +## 2. Define the project + +- [ ] Create the [Value Stream Map](value-stream-mapping/value_stream_map_template.odp) — + current state at minimum, future state if the target process is already known +- [ ] Open the **"Define value stream goals"** issue (from the issue templates) and fill it in +- [ ] Open the **"Write project specification"** issue and complete the + [project specification template](PROJECT_SPECIFICATION_TEMPLATE.md) +- [ ] Get the specification reviewed and approved by stakeholders +- [ ] Identify and record non-goals explicitly — don't skip this + +## 3. Planning + +- [ ] Break the specification down into milestones +- [ ] Create the standard setup issues (see `.github/ISSUE_TEMPLATE/`) in the issue tracker +- [ ] Set up a project board / backlog and add the initial issues to it +- [ ] Agree on a definition of "done" for issues and for the project as a whole +- [ ] Identify risks and mitigations (Section 12 of the specification) + +## 4. Environment & tooling + +- [ ] Choose and pin the Python version (`.python-version` / `pyproject.toml`) +- [ ] Set up the virtual environment / dependency manager +- [ ] Add linting and formatting tools and their configuration +- [ ] Add a test framework and a first smoke test +- [ ] Set up CI (lint, test, build) on push/PR +- [ ] Configure branch protection to require CI + review before merge + +## 5. Documentation + +- [ ] Fill in the README with an actual project description, setup, and usage instructions +- [ ] Link the project specification and value stream map from the README +- [ ] Set up the wiki structure (see `wiki/`) with at least a Home page and a + Getting Started page +- [ ] Document how to run, test, and deploy the project + +## 6. Kickoff + +- [ ] Walk stakeholders through the approved specification and value stream map +- [ ] Confirm milestones and timeline with everyone involved +- [ ] Close out the setup issues once each is genuinely complete — don't just close them to + clear the board +- [ ] Schedule the first review checkpoint (e.g. after MVP / first milestone) + +## Project-specific additions + +- [ ] +- [ ] diff --git a/docs/PROJECT_SPECIFICATION_TEMPLATE.md b/docs/PROJECT_SPECIFICATION_TEMPLATE.md new file mode 100644 index 0000000..b5da66d --- /dev/null +++ b/docs/PROJECT_SPECIFICATION_TEMPLATE.md @@ -0,0 +1,155 @@ +# Project Specification: + +> **How to use this template:** Copy this file to `docs/PROJECT_SPECIFICATION.md` in your new +> project, then work through it top to bottom. Every `` should be replaced or +> removed. Sections marked *(optional)* can be deleted if they genuinely don't apply — don't +> delete them just because they're hard to answer. Keep this document updated as the project +> evolves; it is the single source of truth for what the project is and why. + +| | | +|---|---| +| **Status** | Draft / In Review / Approved | +| **Owner** | | +| **Created** | | +| **Last updated** | | +| **Version** | 0.1 | + +--- + +## 1. Summary + +A short (3–5 sentence) description of the project, written so that someone outside the +project can understand what it is and why it exists without reading further. + +## 2. Problem Statement + +- What problem are we solving? +- Who has this problem, and how do they experience it today? +- What happens if we do nothing? + +## 3. Goals + +Concrete, testable statements of what success looks like. Prefer measurable outcomes over +vague aspirations. + +- [ ] Goal 1 +- [ ] Goal 2 +- [ ] Goal 3 + +## 4. Non-Goals + +Explicitly out of scope. This section prevents scope creep and mismatched expectations — +it is as important as the goals section. + +- Non-goal 1 +- Non-goal 2 + +## 5. Stakeholders + +| Role | Name | Interest / Responsibility | +|---|---|---| +| Sponsor | | | +| Product owner | | | +| Tech lead | | | +| End users | | | +| Other | | | + +## 6. Background & Context *(optional)* + +Relevant history, prior attempts, related systems, or decisions that shape this project. +Link to the [Value Stream Map](../docs/value-stream-mapping/) if one has been produced — +it often surfaces the problem this project addresses. + +## 7. Scope + +### 7.1 In Scope +- Item 1 +- Item 2 + +### 7.2 Out of Scope +- Item 1 +- Item 2 + +## 8. Requirements + +### 8.1 Functional Requirements + +| ID | Requirement | Priority (Must/Should/Could/Won't) | +|---|---|---| +| FR-1 | | Must | +| FR-2 | | Should | + +### 8.2 Non-Functional Requirements + +Consider at least: performance, scalability, security, privacy, accessibility, +reliability/availability, maintainability, observability, compliance. + +| ID | Requirement | Notes | +|---|---|---| +| NFR-1 | | | +| NFR-2 | | | + +## 9. Users & Use Cases *(optional)* + +Describe the primary user(s)/persona(s) and the key use cases or user stories. + +- As a ``, I want to ``, so that ``. + +## 10. Architecture & Design + +- High-level architecture (diagram, or link to one). +- Key components and their responsibilities. +- Technology choices and why they were made. +- Data model / schema, if applicable. +- External interfaces / APIs / integrations. + +## 11. Constraints & Assumptions + +| Type | Description | +|---|---| +| Constraint | e.g. must run on existing infrastructure, fixed deadline, budget cap | +| Assumption | e.g. third-party API will remain stable, expected data volume | + +## 12. Risks + +| Risk | Likelihood | Impact | Mitigation | +|---|---|---|---| +| | Low/Med/High | Low/Med/High | | + +## 13. Milestones & Timeline + +| Milestone | Target date | Notes | +|---|---|---| +| Project kickoff | | | +| Specification approved | | | +| MVP / first working version | | | +| Release | | | + +## 14. Success Metrics / Acceptance Criteria + +How will we know the project succeeded? Prefer measurable, falsifiable criteria over +"it works." + +- [ ] Criterion 1 +- [ ] Criterion 2 + +## 15. Open Questions + +Track unresolved questions here so they don't get lost. Move resolved items to a decision +log or into the relevant section above. + +| Question | Owner | Status | +|---|---|---| +| | | Open | + +## 16. Glossary *(optional)* + +| Term | Definition | +|---|---| +| | | + +## 17. Revision History + +| Version | Date | Author | Summary of changes | +|---|---|---|---| +| 0.1 | | | Initial draft | -- 2.39.5 From 9cddd1c4b9d8c67abf666baa3db9547a5191e2dd Mon Sep 17 00:00:00 2001 From: Lerking <1+lerking@noreply.localhost> Date: Wed, 26 Aug 2026 12:37:38 +0200 Subject: [PATCH 4/7] Upload files to "docs/value-stream-mapping" --- .../value_stream_map_template.odp | Bin 0 -> 4829 bytes 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 docs/value-stream-mapping/value_stream_map_template.odp diff --git a/docs/value-stream-mapping/value_stream_map_template.odp b/docs/value-stream-mapping/value_stream_map_template.odp new file mode 100644 index 0000000000000000000000000000000000000000..4a73e92645dab64d0cc43ca53a07ebbacad2e880 GIT binary patch literal 4829 zcmZ`-2Q*w=+Z{C_O7t>OBGHGaqeUkYh7m*yLKp^v38S}&UPd=s^!n;Th=^XJ*XTl` zw`kEu`6b`?{qO%~{olFktaHx2&)(~<=Q(HHySJtq9zHeTR|D!W8Vhrj6h63~|LQld zyPdTi4CRi5nIVw~YjZP{wS)Zw7kdkS2Qw#YCw>Pc%-+Jm+}RFhkK#uJg z>D6!XKUHqwZmY{in~t!V57G!X$KyEs;Hh(b;gn7p38$&Q=|3-yc*`QBGtYqwx#T7zY+F!7=lP+-<-N=ixJT!ngE1#D#=cy z#FI#{kLwSq_^`kD$o0uj>Ag$;Fs43Hlj}#>(tz({g2PoZ_iuI5xdQWqbc=Z3ms@^H zP2-aTGw9nzU8B^jcRaR>4(Ccj`bgPDH;s(PcUKRmr=xGT>*req1!wA|0Owu*`WnmO zvntKNs;5m)&0(H2UeS0V``HKZ&+3i5>nPYH0RVO~0DxQ9)iZanNByezb@{f9Hyvld zw3kg#zdemj%g$`24a?#hsj}}7VRT#sUu~7_UCP)G`8P2EAY0#`ch3U6V+rK6J{jUW z2&HKyw^M}nx(=Kokw`$?s;qQ5$!-8brE8_567(|?N9b9}`pUO&CuV0^P9Eo@%S{7& zUS-AbY%}Ku1&;N?$@_<#neWxDzRfp?8_ulYE2_A1a2VaSQWztuiC&*b2~dN=U#OUP zzex{;+v$RhTmx@Xm-hAqZAx0$-fUY5YyY${$Sv4 zR$HS2@fErAIo1)iuFXPb zI#65w_OHgD`1TI_s z&vqpYR)OvKq`)WUhu#nu+q>sb%_WnRZjKsjU^&~Nj#zDAl6rAysMi;PP+xgX#UoK3 zi%m_Kyg#qPos0wMMeB^dawHYq+vD8gOW3qTIPnP`)FoI>+rQ@Mo#iLY#ZCi9+wK%f zEO|3XKD8}KV`kcT{lsHPMmQa-K2d32Bux=`E>>g~vi9h4bjhriy&oOBWX4;GDOOKxTZi6;QkV7?vL85D*aMGrni!q^ef>AA|wXuM2L(g4EOY?1(<7NDGf8}fFNP-yXz z5A{b-8nGNpXw?f$^N%67CD4AIpqKz`;1Q?Vu}~{*8W5~TlBxQodYTrV^mW=4OL2a& z`r@$O9YUYgJln|&@C$m|<+Y@BztbcYpXr6{?A)AJ`Wx)}_+jUAHNMP{0bnh^OP*z) zL^cCJO1X9!r6E@xQR_z7{w1p}Bw7;yeSxc&(&<-d8!U;kU>U6=DusVH#$_R5JtN*L z(`T@<8>aZ&JBdnS)po@oMgzXEYKpz}N+Z9&n;z?5+xJlrMTO%ZX>NfBHFoxJDS-Cgn5*kuZzh3ii)&tqp>?6dL{j`w-s!VDwz=@@r3!*hPm%cjiMuu+kL+W z9L_LQnaX1+9G;pQqXH4F7TalH9@*99qS+bJm1>1m#qwScl96Or2-S?(ca|j!>0|uR zkUa1Gsqw}!d2Owp>(!#Pkug-(=ai(;=i}Md(WV=d>^l5=5A9$K53*Ed@hskW`_M&atH zS;Y*Ri1KQwR(#-X@1$iSj~~mtvBZ3}$tMIVNo~(^*-G2(<=m>lKB$kE08CoWlX)9? zK$k!Yfi(&b7gcbMbY2B_-~tDYj^}d;KQ2tC;)O@}8%s_Qly=L5jPTZ8C|2PTFsCRU znXXbH7>|%U@hyot8Y(VCYrej^^k;ICFxUF$Lc4KPo5Au(c4SBEt&r!886zLM7vl6N zIs&xQ(_cQq(%d^P8tyAJ=@)3Bcj%Ltk+a&&mzK0SBIfX9SWxea`FZbo8y&+6(T}lP zy1dVQom0&?l>t>^QrLkf2;6<1O66jMmkAlsPoL(#Vp2GZb86it&KHSQ2(zF$*|2O) zJOYile57@z)aNZKb^8Dg6Tg&i-8*KN$O5^3PUSU;BUcT598Z^kjHfTKrsVk)PtWvG zdqPsfe#XSLiMn(n$isg7hvUSGV8-)P@^__Ss_&ZEpNS>MPu$Zs>cnXL9Oh0bD@Chc z=vip%v|}JYW2`}F@^7hx<=y#75qxR;Bit`i%;|5X1vTudME(dN_#*CwF^@VKeyAct z`gZuU0H|u8d?I)@kxi(Un4x2CM;3ZR^#|~f%01S}YJ^Mkb>DgZ9VYhrdJ|RE(4}0h zaM$qrL|8u?0%U-Bm8w~UVpRnovb)5D{;{e(k{;n8K%XV@aMShvxH&<`+*`_cnb_W^ zUeR?2ac%k9V$AC6t-&d!pRk}Z36Qc-fE@sNq~3L`cKQ`MJD9$XSQwvu} zU;v}*4mKc?A@-G9wQy$YZ&DUnwh{Cu)xKwt259hdeqBR;-;G>&_wG?ia(<`xQN-YALb9;T=j~cc zW_sneKrwhs zKss`)>{d-**!5%IKpi0R(mir>(DZ?x@M+S50&Ls*!=ynrnIh&sZfG>9E7B)FTW$2- z>3NT1Gy%Kff=#!gWb5Ez?HrW`p2WV1%yXQqH22sW`it#HCFf(% zmUOHsP$95tGR7~cHR3c_#gxpz(AE4qm(| zbM?>og0}Q0I6Ig>T->qPqifrv6WfuQFWYe&W6JInRdyKJnTR%+%O4hZ63Y>pKeol6r}L_^BDP?E-jOHK!rWTv zLe}s@E585k12T!^;$**gueDo3QuxfmFZKMr--^9Ap{;*JWI}{uubu8iUjH|4p_9P! zfhK&(w&t0`hZ-|oa8Sl5WrsRDavZ4iQxKdSZYyFwI;2{)#B|@Xe9wTHRtBr~#R6Z+M-84t&GUp7R_iKcLG5u4gIr)zD^AAzp5ZQ!Ihs1S*1z_JH zXssXSQ8Qu-^ANu~)d4C94Z291lVT{-I@D9;Y|ul}it@=ocn z_}7Zo8}HvT8HO_Zt!Lu|9sC7u2OeJ%x3}WQ7b?OStp0ijR+K`a`sDc*h2Jr$UU}P5 z-q(H~yXyJ%plXLnn%}0+Qb5-R5uWb>5|Yc33RQgmsVS{z^;jg>^3SqK!M;LVk?(G#ehN@$@eG05$CB#4 zfs$#09+;V4{uWO!ywc6dO8_`vz$5~PlWu%ON7Gwdbr?*6!>_)yv z5u@Q%%CLvZ7vDK@EY3eO^=hl1_TF`-BCfSR&9!<|SJsi|d!q5^ft{JXwI$5yw~j2; z>9r4FrJg(HjR5Mw>utN&wpMOUlbhbYLurCjeRfQsbuT}83A{eg?A{{nR#&E~d&|j$ zeoo9`+g4jpy`SrFOe}*%>~P*FI5C{f5V?XkFI&_-$_yMJfO$(xp-J~z&DE(7#5ED1 z(VVQRmy!#V=p40+HgW{1rb{cvr~}u}k*a3ttl|lBi-dn_R_?Fj#1Nno`rZ8ytbrwJ z=@w6X#Vd{iVGz{`e(&M^HW}!y@{Tf>$eO=+g&bibVlydfM$iz!s+qg=c0*}rx6%@6 zNv_gV7fqrZF;ir2hoS7K_dImgW9bb;zsanaT6Q{JJs98cUu%wic~$QEuY_ll#0g!2&xW)KtU4rN;a3M$L63;>Yp_w0K5w=eT2?oSWkZyXiwKOBKSfqx#9zk!_O*RT2SWAi8K&rS0;>gnzO YvV}C&2nc_L5nNxa*ZZx2;@9eb0N63>%>V!Z literal 0 HcmV?d00001 -- 2.39.5 From bb51cd421dfbcf7d6bd59f8151e1f7a9ac4d1e98 Mon Sep 17 00:00:00 2001 From: Lerking <1+lerking@noreply.localhost> Date: Wed, 26 Aug 2026 12:38:29 +0200 Subject: [PATCH 5/7] Delete README.md --- README.md | 30 ------------------------------ 1 file changed, 30 deletions(-) delete mode 100644 README.md diff --git a/README.md b/README.md deleted file mode 100644 index b6f8604..0000000 --- a/README.md +++ /dev/null @@ -1,30 +0,0 @@ -# Python repo template -[![GitHub forks](https://img.shields.io/github/forks/Lerking/python-repo-template.svg?style=social&label=Fork&maxAge=2592000)](https://GitHub.com/Lerking/python-repo-template/forks/) -[![GitHub stars](https://img.shields.io/github/stars/Lerking/python-repo-template.svg?style=social&label=Star&maxAge=2592000)](https://GitHub.com/Lerking/python-repo-template/stargazers/) -[![GitHub watchers](https://img.shields.io/github/watchers/Lerking/python-repo-template.svg?style=social&label=Watch&maxAge=2592000)](https://GitHub.com/Lerking/python-repo-template/watchers/) - -[![forthebadge made-with-python](http://ForTheBadge.com/images/badges/made-with-python.svg)](https://www.python.org/) - -[![GitHub version](https://badge.fury.io/gh/Lerking-python-repo-template.svg)](https://github.com/Lerking/python-repo-template) - -[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://GitHub.com/Lerking/python-repo-template.github.io/graphs/commit-activity) -[![GitHub contributors](https://img.shields.io/github/contributors/Lerking/python-repo-template.svg)](https://GitHub.com/Lerking/python-repo-template/graphs/contributors/) - -[![Github file count](https://img.shields.io/github/directory-file-count/Lerking/python-repo-template)]() - -[![GitHub issues](https://img.shields.io/github/issues/Lerking/python-repo-template.svg)](https://GitHub.com/Lerking/python-repo-template/issues/) -[![GitHub issues-closed](https://img.shields.io/github/issues-closed/Lerking/python-repo-template.svg)](https://GitHub.com/Lerking/python-repo-template/issues?q=is%3Aissue+is%3Aclosed) -[![Percentage of issues still open](http://isitmaintained.com/badge/open/Lerking/python-repo-template.svg)](http://isitmaintained.com/project/Lerking/python-repo-template "Percentage of issues still open") -[![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/Lerking/python-repo-template.svg)](http://isitmaintained.com/project/Lerking/python-repo-template "Average time to resolve an issue") - -[![GitHub pull-requests](https://img.shields.io/github/issues-pr/Lerking/python-repo-template.svg)](https://GitHub.com/Lerking/python-repo-template/pull) -[![GitHub total-pull-requests](https://badgen.net/github/prs/Lerking/python-repo-template)](https://GitHub.com/Lerking/python-repo-template/pull) - -Coding time for this reposotory.
-[![wakatime](https://wakatime.com/badge/user/d43f2852-fd6f-45b4-b713-558ad18204d4/project/dcf411f9-6d3e-4b14-9290-5ed419cf4012.svg)](https://wakatime.com/badge/user/d43f2852-fd6f-45b4-b713-558ad18204d4/project/dcf411f9-6d3e-4b14-9290-5ed419cf4012) - -See the wiki for usage and examples. -[python-repo-template wiki page](https://github.com/Lerking/python-repo-template/wiki) - -Visitors since repo creation.
-![Visitor Badge](https://visitor-badge.laobi.icu/badge?page_id=Lerking.python-repo-template) \ No newline at end of file -- 2.39.5 From f3525f3fc4d6e2671d437e87c6eaf6047292980f Mon Sep 17 00:00:00 2001 From: Lerking <1+lerking@noreply.localhost> Date: Wed, 26 Aug 2026 12:39:24 +0200 Subject: [PATCH 6/7] Upload files to "/" --- README.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..f673f9d --- /dev/null +++ b/README.md @@ -0,0 +1,46 @@ +# Python repo template +[![GitHub forks](https://img.shields.io/github/forks/Lerking/python-repo-template.svg?style=social&label=Fork&maxAge=2592000)](https://GitHub.com/Lerking/python-repo-template/forks/) +[![GitHub stars](https://img.shields.io/github/stars/Lerking/python-repo-template.svg?style=social&label=Star&maxAge=2592000)](https://GitHub.com/Lerking/python-repo-template/stargazers/) +[![GitHub watchers](https://img.shields.io/github/watchers/Lerking/python-repo-template.svg?style=social&label=Watch&maxAge=2592000)](https://GitHub.com/Lerking/python-repo-template/watchers/) + +[![forthebadge made-with-python](http://ForTheBadge.com/images/badges/made-with-python.svg)](https://www.python.org/) + +[![GitHub version](https://badge.fury.io/gh/Lerking-python-repo-template.svg)](https://github.com/Lerking/python-repo-template) + +[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://GitHub.com/Lerking/python-repo-template.github.io/graphs/commit-activity) +[![GitHub contributors](https://img.shields.io/github/contributors/Lerking/python-repo-template.svg)](https://GitHub.com/Lerking/python-repo-template/graphs/contributors/) + +[![Github file count](https://img.shields.io/github/directory-file-count/Lerking/python-repo-template)]() + +[![GitHub issues](https://img.shields.io/github/issues/Lerking/python-repo-template.svg)](https://GitHub.com/Lerking/python-repo-template/issues/) +[![GitHub issues-closed](https://img.shields.io/github/issues-closed/Lerking/python-repo-template.svg)](https://GitHub.com/Lerking/python-repo-template/issues?q=is%3Aissue+is%3Aclosed) +[![Percentage of issues still open](http://isitmaintained.com/badge/open/Lerking/python-repo-template.svg)](http://isitmaintained.com/project/Lerking/python-repo-template "Percentage of issues still open") +[![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/Lerking/python-repo-template.svg)](http://isitmaintained.com/project/Lerking/python-repo-template "Average time to resolve an issue") + +[![GitHub pull-requests](https://img.shields.io/github/issues-pr/Lerking/python-repo-template.svg)](https://GitHub.com/Lerking/python-repo-template/pull) +[![GitHub total-pull-requests](https://badgen.net/github/prs/Lerking/python-repo-template)](https://GitHub.com/Lerking/python-repo-template/pull) + +Coding time for this reposotory.
+[![wakatime](https://wakatime.com/badge/user/d43f2852-fd6f-45b4-b713-558ad18204d4/project/dcf411f9-6d3e-4b14-9290-5ed419cf4012.svg)](https://wakatime.com/badge/user/d43f2852-fd6f-45b4-b713-558ad18204d4/project/dcf411f9-6d3e-4b14-9290-5ed419cf4012) + +See the wiki for usage and examples. +[python-repo-template wiki page](https://github.com/Lerking/python-repo-template/wiki) + +Visitors since repo creation.
+![Visitor Badge](https://visitor-badge.laobi.icu/badge?page_id=Lerking.python-repo-template) + +## Using this as a project template + +Beyond the bare Python repo scaffold (`main.py`, `LICENCE`, `.gitignore`), this template +includes everything needed to kick off a new project properly: + +| What | Where | +|---|---| +| Project specification template | [`docs/PROJECT_SPECIFICATION_TEMPLATE.md`](docs/PROJECT_SPECIFICATION_TEMPLATE.md) | +| Value stream mapping template (OpenDocument Presentation) | [`docs/value-stream-mapping/value_stream_map_template.odp`](docs/value-stream-mapping/value_stream_map_template.odp) | +| New project setup checklist | [`docs/NEW_PROJECT_CHECKLIST.md`](docs/NEW_PROJECT_CHECKLIST.md) | +| Wiki template (copy into your repo's actual wiki) | [`wiki/`](wiki/) | +| Standard first-step issues (value stream goals, specification, wiki setup, checklist) | [`.github/ISSUE_TEMPLATE/`](.github/ISSUE_TEMPLATE/) | + +Start with the checklist — it walks through repository setup, defining the project (value +stream map + specification), planning, tooling, documentation, and kickoff, in order. -- 2.39.5 From cef056f433d64601310874721f3cd2cb80356b89 Mon Sep 17 00:00:00 2001 From: Lerking <1+lerking@noreply.localhost> Date: Wed, 26 Aug 2026 12:45:27 +0200 Subject: [PATCH 7/7] Upload files to ".github/ISSUE_TEMPLATE" --- .../01-define-value-stream-goals.md | 34 +++++++++++++++++ .../02-write-project-specification.md | 38 +++++++++++++++++++ .../ISSUE_TEMPLATE/03-set-up-project-wiki.md | 26 +++++++++++++ .../04-complete-new-project-checklist.md | 29 ++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + 5 files changed, 128 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/01-define-value-stream-goals.md create mode 100644 .github/ISSUE_TEMPLATE/02-write-project-specification.md create mode 100644 .github/ISSUE_TEMPLATE/03-set-up-project-wiki.md create mode 100644 .github/ISSUE_TEMPLATE/04-complete-new-project-checklist.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/01-define-value-stream-goals.md b/.github/ISSUE_TEMPLATE/01-define-value-stream-goals.md new file mode 100644 index 0000000..7faf9d7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/01-define-value-stream-goals.md @@ -0,0 +1,34 @@ +--- +name: "1. Define value stream goals" +about: "First step for a new project — map the current process and set value stream goals." +title: "Define value stream goals" +labels: ["setup", "planning"] +assignees: "" +--- + +## Task + +Produce the **current state** value stream map (and future state, if the target process is +already known) for this project, using +[`docs/value-stream-mapping/value_stream_map_template.odp`](../../docs/value-stream-mapping/value_stream_map_template.odp). + +## Steps + +- [ ] Identify the process boundaries: where does the value stream start and end? +- [ ] Walk the current process step by step with the people who actually do the work +- [ ] Fill in the current state map: process steps, cycle time, wait time, %C&A, inventory + between steps +- [ ] Calculate total lead time and total cycle time +- [ ] Identify bottlenecks, waste, and improvement opportunities +- [ ] Draft the future state map reflecting the target process +- [ ] Record improvement actions with an owner and a due date +- [ ] Summarize headline metrics and actions on the + [Value Stream Mapping wiki page](../../wiki/Value-Stream-Mapping.md) +- [ ] Share the map with stakeholders for feedback + +## Definition of done + +- [ ] Current (and, if applicable, future) state maps are complete in the `.odp` file +- [ ] Metrics and action items are summarized on the wiki page +- [ ] Stakeholders have reviewed the map +- [ ] Findings feed into the [project specification issue](02-write-project-specification.md) diff --git a/.github/ISSUE_TEMPLATE/02-write-project-specification.md b/.github/ISSUE_TEMPLATE/02-write-project-specification.md new file mode 100644 index 0000000..73fc04b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/02-write-project-specification.md @@ -0,0 +1,38 @@ +--- +name: "2. Write project specification" +about: "First step for a new project — complete and get approval on the project specification." +title: "Write project specification" +labels: ["setup", "planning"] +assignees: "" +--- + +## Task + +Complete [`docs/PROJECT_SPECIFICATION.md`](../../docs/PROJECT_SPECIFICATION_TEMPLATE.md) +(copied from the project specification template) for this project, and get it reviewed and +approved by stakeholders. + +## Steps + +- [ ] Copy `docs/PROJECT_SPECIFICATION_TEMPLATE.md` to `docs/PROJECT_SPECIFICATION.md` +- [ ] Write the summary and problem statement +- [ ] List goals and — just as importantly — non-goals +- [ ] Identify stakeholders and their roles +- [ ] Define scope (in scope / out of scope) +- [ ] Write functional and non-functional requirements +- [ ] Sketch the architecture & design section (can stay high-level at this stage) +- [ ] List constraints, assumptions, and risks +- [ ] Draft milestones and a timeline +- [ ] Define success metrics / acceptance criteria +- [ ] Incorporate findings from the + [value stream mapping issue](01-define-value-stream-goals.md), if applicable +- [ ] Circulate for review and log open questions in Section 15 +- [ ] Get sign-off from the stakeholders listed in Section 5 and set status to "Approved" + +## Definition of done + +- [ ] `docs/PROJECT_SPECIFICATION.md` exists and every section is filled in or deliberately + removed +- [ ] Specification status is "Approved" and the revision history is up to date +- [ ] Summary is copied onto the + [Project Specification wiki page](../../wiki/Project-Specification.md) diff --git a/.github/ISSUE_TEMPLATE/03-set-up-project-wiki.md b/.github/ISSUE_TEMPLATE/03-set-up-project-wiki.md new file mode 100644 index 0000000..f149c34 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/03-set-up-project-wiki.md @@ -0,0 +1,26 @@ +--- +name: "3. Set up project wiki" +about: "First step for a new project — publish the wiki template pages." +title: "Set up project wiki" +labels: ["setup", "documentation"] +assignees: "" +--- + +## Task + +Publish the pages from [`wiki/`](../../wiki/) to the repository's actual wiki (or your team's +wiki tool), and fill each one in for this project. + +## Steps + +- [ ] Copy `wiki/Home.md`, `Getting-Started.md`, `Architecture.md`, `Project-Specification.md`, + `Value-Stream-Mapping.md`, and `FAQ.md` into the live wiki +- [ ] Fill in Home with real links (repo, issue tracker, CI) and conventions +- [ ] Fill in Getting Started with real install/run/test instructions +- [ ] Link the approved project specification and value stream map from their wiki pages +- [ ] Remove the "how to use this template" notes once pages are populated + +## Definition of done + +- [ ] Wiki is live and linked from the README +- [ ] Getting Started page is accurate enough that a new contributor can follow it unaided diff --git a/.github/ISSUE_TEMPLATE/04-complete-new-project-checklist.md b/.github/ISSUE_TEMPLATE/04-complete-new-project-checklist.md new file mode 100644 index 0000000..b201a1e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/04-complete-new-project-checklist.md @@ -0,0 +1,29 @@ +--- +name: "4. Complete new project checklist" +about: "First step for a new project — work through the full repo/project setup checklist." +title: "Complete new project checklist" +labels: ["setup"] +assignees: "" +--- + +## Task + +Work through [`docs/NEW_PROJECT_CHECKLIST.md`](../../docs/NEW_PROJECT_CHECKLIST.md) end to +end. This issue is the tracking wrapper for that checklist — paste its sections in below (or +just check them off in the file itself and link to the commit). + +## Checklist + +- [ ] Repository setup complete +- [ ] Value stream map complete (see [issue 1](01-define-value-stream-goals.md)) +- [ ] Project specification approved (see [issue 2](02-write-project-specification.md)) +- [ ] Planning complete: milestones set, setup issues created, board in place +- [ ] Environment & tooling configured (Python version, linting, tests, CI) +- [ ] Documentation complete: README, wiki (see [issue 3](03-set-up-project-wiki.md)) +- [ ] Kickoff held with stakeholders + +## Definition of done + +- [ ] Every item in `docs/NEW_PROJECT_CHECKLIST.md` is checked or explicitly marked N/A with + a reason +- [ ] The project is ready for regular development work to begin diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..0086358 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: true -- 2.39.5