oifmd 0.1.0.dev0__tar.gz

oifmd-0.1.0.dev0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

oifmd-0.1.0.dev0/PKG-INFO

@@ -0,0 +1,136 @@
+Metadata-Version: 2.4
+Name: oifmd
+Version: 0.1.0.dev0
+Summary: Open Issue Format (OIF) validator and tools
+License: Apache-2.0
+Project-URL: Homepage, https://oif.md
+Project-URL: Source, https://github.com/oifmd/oifmd
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pyyaml>=6
+Dynamic: license-file
+
+# Open Issue Format (OIF)
+
+**Issues as files.** A directory of Markdown files that any agent or
+human can run as a board with `ls`, `cat` and `git mv`. No tool required.
+
+- **Spec:** [SPEC.md](SPEC.md) · version 0.1 (draft)
+- **Site:** https://oif.md
+- **Package:** `oifmd` (validator and converters)
+
+## Sixty-second tour
+
+```
+board.md
+issues/
+├── backlog/
+│   ├── column.md
+│   └── add-jira-importer-nkhnsk.md
+├── doing/
+│   ├── column.md
+│   └── fix-login-redirect-loop-7k2x9m.md
+└── done/
+    ├── column.md
+    └── write-spec-outline-h87456.md
+```
+
+The directory is the status. The filename is the identity. Moving an
+issue is `git mv issues/doing/fix-login-redirect-loop-7k2x9m.md issues/done/`.
+
+`issues/doing/fix-login-redirect-loop-7k2x9m.md`:
+
+```markdown
+---
+type: issue
+resource: oif:app/7k2x9m
+title: Login form rejects passwords containing "!"
+kind: bug
+priority: high
+assignees: [coder/1.4]
+requested_by: human:sam
+tags: [auth]
+created: 2026-09-13T03:10:00Z
+---
+
+Submitting a correct password with `!` clears the form and shows
+"invalid credentials". Expected: login succeeds.
+
+## Acceptance Criteria
+
+- [x] Reproduce with a failing test
+- [ ] Fix without changing the hashing path
+
+```
+
+Comments are separate files, one per comment, keyed by the issue's id:
+
+`comments/7k2x9m/k3n2wp.md`
+
+```markdown
+---
+type: comment
+at: 2026-09-13T04:12:00Z
+by: human:sam
+kind: verdict
+result: changes_requested
+---
+
+Keep the strip for whitespace only.
+```
+
+Read an issue and its whole history with one command:
+
+```sh
+cat issues/*/*-7k2x9m.md comments/7k2x9m/*.md
+```
+
+## Why
+
+Every git-native tracker (Backlog.md, git-issues, beaver-backlog, beads)
+converged on Markdown plus frontmatter, one file per issue. None
+published the format separately from the tool. OIF is the format,
+written down, with a validator, so issues outlive whichever tool wrote
+them and any agent can read them cold.
+
+Design rules that fall out of being agent-first and git-native:
+
+- **State is the directory.** A move is one atomic rename, not a
+  read-modify-write that two agents can trample.
+- **Identity is a random six-character id in the filename.** Two
+  branches can create issues at once and merge with no counter, no
+  scan, no renumbering. Sequential keys like `APP-2753` survive as
+  aliases.
+- **One comment is one file**, keyed by the issue's id. Two agents
+  commenting at once write two different paths, so nothing conflicts and
+  nothing is lost. Appending to a shared file does not survive concurrent
+  writers; see the changelog.
+- **Unknown keys are preserved.** Your tracker's extra fields round-trip.
+- **Every column has a `column.md`.** It keeps empty columns in git and
+  tells an arriving agent what belongs there and how to leave.
+- **The board declares its own vocabulary.** `board.md` lists the columns
+  and, optionally, the `kinds` an issue may have and which kinds may
+  contain which. Epic, story and task are one team's words, not the
+  format's. Ready `board.md` files for Kanban, Scrum and Shape Up are in
+  [`profiles/`](profiles/).
+
+An OIF board is a conforming [Open Knowledge Format](https://okf.md)
+bundle: same substrate, same actor convention, `type: issue` on every
+file. The one deliberate divergence, identity by id rather than by path,
+is spelled out in SPEC.md section 9. Trackers are platforms, OIF is the
+file.
+
+## This repository
+
+The roadmap for OIF itself lives in [`board/`](board/), in OIF.
+GitHub Issues stays open for conversation; accepted work lands in
+`board/issues/` with the GitHub number kept in `external_ids`.
+
+## Status
+
+0.1 is a draft. Expect 0.x to move.
+
+## License
+
+Apache-2.0.

oifmd-0.1.0.dev0/README.md

@@ -0,0 +1,123 @@
+# Open Issue Format (OIF)
+
+**Issues as files.** A directory of Markdown files that any agent or
+human can run as a board with `ls`, `cat` and `git mv`. No tool required.
+
+- **Spec:** [SPEC.md](SPEC.md) · version 0.1 (draft)
+- **Site:** https://oif.md
+- **Package:** `oifmd` (validator and converters)
+
+## Sixty-second tour
+
+```
+board.md
+issues/
+├── backlog/
+│   ├── column.md
+│   └── add-jira-importer-nkhnsk.md
+├── doing/
+│   ├── column.md
+│   └── fix-login-redirect-loop-7k2x9m.md
+└── done/
+    ├── column.md
+    └── write-spec-outline-h87456.md
+```
+
+The directory is the status. The filename is the identity. Moving an
+issue is `git mv issues/doing/fix-login-redirect-loop-7k2x9m.md issues/done/`.
+
+`issues/doing/fix-login-redirect-loop-7k2x9m.md`:
+
+```markdown
+---
+type: issue
+resource: oif:app/7k2x9m
+title: Login form rejects passwords containing "!"
+kind: bug
+priority: high
+assignees: [coder/1.4]
+requested_by: human:sam
+tags: [auth]
+created: 2026-09-13T03:10:00Z
+---
+
+Submitting a correct password with `!` clears the form and shows
+"invalid credentials". Expected: login succeeds.
+
+## Acceptance Criteria
+
+- [x] Reproduce with a failing test
+- [ ] Fix without changing the hashing path
+
+```
+
+Comments are separate files, one per comment, keyed by the issue's id:
+
+`comments/7k2x9m/k3n2wp.md`
+
+```markdown
+---
+type: comment
+at: 2026-09-13T04:12:00Z
+by: human:sam
+kind: verdict
+result: changes_requested
+---
+
+Keep the strip for whitespace only.
+```
+
+Read an issue and its whole history with one command:
+
+```sh
+cat issues/*/*-7k2x9m.md comments/7k2x9m/*.md
+```
+
+## Why
+
+Every git-native tracker (Backlog.md, git-issues, beaver-backlog, beads)
+converged on Markdown plus frontmatter, one file per issue. None
+published the format separately from the tool. OIF is the format,
+written down, with a validator, so issues outlive whichever tool wrote
+them and any agent can read them cold.
+
+Design rules that fall out of being agent-first and git-native:
+
+- **State is the directory.** A move is one atomic rename, not a
+  read-modify-write that two agents can trample.
+- **Identity is a random six-character id in the filename.** Two
+  branches can create issues at once and merge with no counter, no
+  scan, no renumbering. Sequential keys like `APP-2753` survive as
+  aliases.
+- **One comment is one file**, keyed by the issue's id. Two agents
+  commenting at once write two different paths, so nothing conflicts and
+  nothing is lost. Appending to a shared file does not survive concurrent
+  writers; see the changelog.
+- **Unknown keys are preserved.** Your tracker's extra fields round-trip.
+- **Every column has a `column.md`.** It keeps empty columns in git and
+  tells an arriving agent what belongs there and how to leave.
+- **The board declares its own vocabulary.** `board.md` lists the columns
+  and, optionally, the `kinds` an issue may have and which kinds may
+  contain which. Epic, story and task are one team's words, not the
+  format's. Ready `board.md` files for Kanban, Scrum and Shape Up are in
+  [`profiles/`](profiles/).
+
+An OIF board is a conforming [Open Knowledge Format](https://okf.md)
+bundle: same substrate, same actor convention, `type: issue` on every
+file. The one deliberate divergence, identity by id rather than by path,
+is spelled out in SPEC.md section 9. Trackers are platforms, OIF is the
+file.
+
+## This repository
+
+The roadmap for OIF itself lives in [`board/`](board/), in OIF.
+GitHub Issues stays open for conversation; accepted work lands in
+`board/issues/` with the GitHub number kept in `external_ids`.
+
+## Status
+
+0.1 is a draft. Expect 0.x to move.
+
+## License
+
+Apache-2.0.

oifmd-0.1.0.dev0/pyproject.toml

@@ -0,0 +1,22 @@
+[build-system]
+requires = ["setuptools>=68"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "oifmd"
+version = "0.1.0.dev0"
+description = "Open Issue Format (OIF) validator and tools"
+readme = "README.md"
+license = { text = "Apache-2.0" }
+requires-python = ">=3.10"
+dependencies = ["pyyaml>=6"]
+
+[project.urls]
+Homepage = "https://oif.md"
+Source = "https://github.com/oifmd/oifmd"
+
+[project.scripts]
+oifmd = "oifmd.cli:main"
+
+[tool.setuptools.packages.find]
+where = ["src"]

oifmd-0.1.0.dev0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

oifmd-0.1.0.dev0/src/oifmd/__init__.py

@@ -0,0 +1,2 @@
+"""Open Issue Format (OIF) reference tooling. Spec: https://oif.md"""
+__version__ = "0.1.0.dev0"

oifmd-0.1.0.dev0/src/oifmd/__main__.py

@@ -0,0 +1,2 @@
+from .cli import main
+raise SystemExit(main())

oifmd-0.1.0.dev0/src/oifmd/cli.py

@@ -0,0 +1,421 @@
+"""oifmd — validate and operate an OIF board with nothing but the filesystem.
+
+Usage:
+  oifmd validate [BOARD]          exit 0 if BOARD conforms to OIF 0.1
+  oifmd ls [BOARD] [COLUMN]       list issues by column
+  oifmd new BOARD COLUMN TITLE    create an issue with a fresh id, print its path
+  oifmd id                        print a fresh id
+  oifmd index [BOARD]             write an OKF-shaped root index.md
+"""
+from __future__ import annotations
+
+import re
+import secrets
+import sys
+from dataclasses import dataclass, field
+from datetime import datetime, timezone
+from pathlib import Path
+
+import yaml
+
+ALPHABET = "0123456789abcdefghjkmnpqrstvwxyz"
+ID_RE = r"[0-9a-hjkmnp-tv-z]{6}"
+SLUG_RE = r"[a-z0-9]+(?:-[a-z0-9]+)*"
+FILENAME_RE = re.compile(rf"^(?P<slug>{SLUG_RE})-(?P<id>{ID_RE})\.md$")
+COLUMN_RE = re.compile(r"^[a-z0-9]+(?:[_-][a-z0-9]+)*$")
+KEY_RE = re.compile(r"^[a-z][a-z0-9]{1,15}$")
+REF_RE = re.compile(rf"^(?:[a-z][a-z0-9]{{1,15}}-)?(?P<id>{ID_RE})$")
+COMMENT_RE = re.compile(
+    r"^### (?P<ts>\d{4}-\d{2}-\d{2}T\d{2}:\d{2}(?::\d{2}(?:\.\d+)?)?(?:Z|[+-]\d{2}:?\d{2}))"
+    r" (?P<actor>\S+)(?P<kv>(?: [a-z][a-z0-9_]*=[A-Za-z0-9_.:/@-]+)*)\s*$"
+)
+RESERVED = ("id", "status", "state", "column")
+RESERVED_FILES = ("column.md", "index.md", "log.md")
+LIST_OF_STR = ("assignees", "tags", "aliases")
+OFFSET_RE = re.compile(r"(?:Z|[+-]\d{2}:?\d{2})$")
+RESOURCE_RE = re.compile(rf"^oif:[a-z][a-z0-9]{{1,15}}/{ID_RE}$")
+LIST_OF_REF = ("depends_on", "related")
+
+
+def new_id() -> str:
+    return "".join(secrets.choice(ALPHABET) for _ in range(6))
+
+
+def slugify(title: str) -> str:
+    s = re.sub(r"[^a-z0-9]+", "-", title.lower()).strip("-")
+    return s[:60].rstrip("-") or "issue"
+
+
+@dataclass
+class Finding:
+    level: str  # "error" | "warn"
+    path: str
+    message: str
+
+    def __str__(self) -> str:
+        return f"{self.level}: {self.path}: {self.message}"
+
+
+@dataclass
+class Issue:
+    path: Path
+    column: str
+    slug: str
+    id: str
+    front: dict = field(default_factory=dict)
+    body: str = ""
+
+
+def split_frontmatter(text: str) -> tuple[dict | None, str, str | None]:
+    """Return (frontmatter, body, error)."""
+    if not text.startswith("---\n"):
+        return None, text, "missing frontmatter"
+    end = text.find("\n---\n", 4)
+    if end < 0:
+        if text.rstrip("\n").endswith("\n---"):
+            end = len(text.rstrip("\n")) - 3
+        else:
+            return None, text, "unterminated frontmatter"
+    raw = text[4:end]
+    try:
+        data = yaml.safe_load(raw)
+    except yaml.YAMLError as exc:  # pragma: no cover - message passthrough
+        return None, text, f"frontmatter is not valid YAML: {exc}"
+    if data is None:
+        data = {}
+    if not isinstance(data, dict):
+        return None, text, "frontmatter must be a YAML mapping"
+    return data, text[end + 5:], None
+
+
+def load_board(root: Path) -> tuple[dict | None, list[Finding]]:
+    findings: list[Finding] = []
+    bm = root / "board.md"
+    if not bm.is_file():
+        return None, [Finding("error", str(bm), "board.md is required")]
+    front, _, err = split_frontmatter(bm.read_text(encoding="utf-8"))
+    if err:
+        return None, [Finding("error", str(bm), err)]
+    if front.get("type") != "board":
+        findings.append(Finding("error", str(bm), "board.md must have type: board"))
+    if str(front.get("oif", "")) != "0.1":
+        findings.append(Finding("error", str(bm), "oif must be \"0.1\""))
+    key = front.get("key")
+    if key is not None and not (isinstance(key, str) and KEY_RE.match(key)):
+        findings.append(Finding("error", str(bm), f"key {key!r} must match {KEY_RE.pattern}"))
+    cols = front.get("columns")
+    if not isinstance(cols, list) or not cols:
+        findings.append(Finding("error", str(bm), "columns must be a non-empty list"))
+        return front, findings
+    names = []
+    for c in cols:
+        if not isinstance(c, dict) or "name" not in c:
+            findings.append(Finding("error", str(bm), f"column entry {c!r} needs a name"))
+            continue
+        n = str(c["name"])
+        if not COLUMN_RE.match(n):
+            findings.append(Finding("error", str(bm), f"column name {n!r} must match {COLUMN_RE.pattern}"))
+        if n in names:
+            findings.append(Finding("error", str(bm), f"duplicate column {n!r}"))
+        names.append(n)
+    front["_column_names"] = names
+    cmode = front.get("comments", "sidecar")
+    if cmode not in ("sidecar", "inline"):
+        findings.append(Finding("error", str(bm), "comments must be 'sidecar' or 'inline'"))
+    front["_comments_mode"] = cmode if cmode in ("sidecar", "inline") else "sidecar"
+    kinds = front.get("kinds")
+    if kinds is not None:
+        if not isinstance(kinds, list) or not all(isinstance(k, dict) and "name" in k for k in kinds):
+            findings.append(Finding("error", str(bm), "kinds must be a list of {name, contains?}"))
+        else:
+            front["_kinds"] = {str(k["name"]): [str(c) for c in (k.get("contains") or [])] for k in kinds}
+    return front, findings
+
+
+def scan_issues(root: Path, board: dict) -> tuple[list[Issue], list[Finding]]:
+    findings: list[Finding] = []
+    issues: list[Issue] = []
+    idir = root / "issues"
+    if not idir.is_dir():
+        return issues, [Finding("error", str(idir), "issues/ directory is required")]
+    declared = set(board.get("_column_names", []))
+    for name in sorted(declared):
+        cm = idir / name / "column.md"
+        if not (idir / name).is_dir():
+            findings.append(Finding("error", str(idir / name), "declared column has no directory (add a column.md)"))
+        elif not cm.is_file():
+            findings.append(Finding("error", str(cm), "every column directory must contain column.md"))
+        else:
+            front, _, err = split_frontmatter(cm.read_text(encoding="utf-8"))
+            if err:
+                findings.append(Finding("error", str(cm), err))
+            elif front.get("type") != "column":
+                findings.append(Finding("error", str(cm), "column.md must have type: column"))
+            elif any(k in front for k in ("wip", "complete", "hidden", "order")):
+                findings.append(Finding("error", str(cm), "column config belongs in board.md, not column.md"))
+    for col in sorted(p for p in idir.iterdir() if p.is_dir()):
+        if col.name not in declared:
+            findings.append(Finding("error", str(col), "directory is not a declared column"))
+        for f in sorted(col.iterdir()):
+            if f.name in RESERVED_FILES:
+                if f.name == "index.md" and f.read_text(encoding="utf-8").startswith("---\n"):
+                    findings.append(Finding("warn", str(f), "index.md inside a column must not carry frontmatter (OKF section 8)"))
+                continue
+            if f.is_dir():
+                findings.append(Finding("error", str(f), "subdirectories inside a column are not allowed"))
+                continue
+            if f.suffix != ".md":
+                findings.append(Finding("warn", str(f), "non-markdown file in a column is ignored"))
+                continue
+            m = FILENAME_RE.match(f.name)
+            if not m:
+                findings.append(Finding("error", str(f), "filename must be <slug>-<id>.md with a 6-char Crockford id"))
+                continue
+            issues.append(Issue(f, col.name, m["slug"], m["id"]))
+    return issues, findings
+
+
+def check_comments_dir(root: Path, ids: set[str]) -> list[Finding]:
+    """Validate comments/<issue-id>/<comment-id>.md (spec 4.4)."""
+    out: list[Finding] = []
+    cdir = root / "comments"
+    if not cdir.is_dir():
+        return out
+    for sub in sorted(p for p in cdir.iterdir()):
+        if not sub.is_dir():
+            out.append(Finding("error", str(sub), "comments/ holds one directory per issue id"))
+            continue
+        if not re.fullmatch(ID_RE, sub.name):
+            out.append(Finding("error", str(sub), f"{sub.name!r} is not an issue id"))
+            continue
+        if sub.name not in ids:
+            out.append(Finding("error", str(sub), f"no issue with id {sub.name} on this board"))
+            continue
+        for f in sorted(sub.iterdir()):
+            if f.name in ("index.md", "log.md"):
+                continue
+            if not re.fullmatch(rf"{ID_RE}\.md", f.name):
+                out.append(Finding("error", str(f), "comment filename must be <id>.md with a 6-char id"))
+                continue
+            front, _, err = split_frontmatter(f.read_text(encoding="utf-8"))
+            if err:
+                out.append(Finding("error", str(f), err)); continue
+            if front.get("type") != "comment":
+                out.append(Finding("error", str(f), "comment must have type: comment"))
+            at = front.get("at")
+            if at is None:
+                out.append(Finding("error", str(f), "comment requires at"))
+            elif isinstance(at, datetime):
+                if at.tzinfo is None:
+                    out.append(Finding("error", str(f), "at must carry Z or a numeric offset"))
+            elif not (isinstance(at, str) and OFFSET_RE.search(at)):
+                out.append(Finding("error", str(f), "at must be ISO 8601 with Z or a numeric offset"))
+            if not isinstance(front.get("by"), str) or not front.get("by"):
+                out.append(Finding("error", str(f), "comment requires by (an actor)"))
+    return out
+
+
+def check_issue(issue: Issue, ids: set[str], key: str | None = None) -> list[Finding]:
+    p = str(issue.path)
+    out: list[Finding] = []
+    front, body, err = split_frontmatter(issue.path.read_text(encoding="utf-8"))
+    if err:
+        return [Finding("error", p, err)]
+    issue.front, issue.body = front, body
+    if front.get("type") != "issue":
+        out.append(Finding("error", p, "frontmatter must have type: issue"))
+    res = front.get("resource")
+    if res is not None and not (isinstance(res, str) and RESOURCE_RE.match(res)):
+        out.append(Finding("error", p, "resource must be oif:<key>/<id>"))
+    elif isinstance(res, str) and not res.endswith("/" + issue.id):
+        out.append(Finding("error", p, f"resource {res} does not end with this file's id {issue.id}"))
+    for k in ("kind", "description", "priority"):
+        if k in front and not isinstance(front[k], str):
+            out.append(Finding("error", p, f"{k} must be a string"))
+    for k in RESERVED:
+        if k in front:
+            out.append(Finding("error", p, f"reserved key {k!r} must not appear in frontmatter"))
+    for k in LIST_OF_STR:
+        v = front.get(k)
+        if v is not None and not (isinstance(v, list) and all(isinstance(x, str) for x in v)):
+            out.append(Finding("error", p, f"{k} must be a list of strings"))
+    for k in LIST_OF_REF:
+        v = front.get(k)
+        if v is None:
+            continue
+        if not isinstance(v, list):
+            out.append(Finding("error", p, f"{k} must be a list of issue references"))
+            continue
+        for r in v:
+            out.extend(_check_ref(p, k, r, ids))
+    if front.get("parent") is not None:
+        out.extend(_check_ref(p, "parent", front["parent"], ids))
+    ext = front.get("external_ids")
+    if ext is not None and not (isinstance(ext, dict) and all(isinstance(v, str) for v in ext.values())):
+        out.append(Finding("error", p, "external_ids must be a map of string to string"))
+    created = front.get("created")
+    if created is not None:
+        if isinstance(created, datetime):
+            if created.tzinfo is None:
+                out.append(Finding("error", p, "created must carry Z or a numeric offset"))
+        elif not (isinstance(created, str) and OFFSET_RE.search(created)):
+            out.append(Finding("error", p, "created must be an ISO 8601 datetime with Z or a numeric offset"))
+    if "title" not in front:
+        out.append(Finding("warn", p, "title is recommended"))
+    if key and "resource" not in front:
+        out.append(Finding("warn", p, f"resource oif:{key}/{issue.id} is recommended"))
+    out.extend(_check_comments(p, body))
+    return out
+
+
+def _check_ref(p: str, k: str, r, ids: set[str]) -> list[Finding]:
+    if not isinstance(r, str) or not REF_RE.match(r):
+        return [Finding("error", p, f"{k}: {r!r} is not an issue reference")]
+    m = REF_RE.match(r)
+    if "-" not in r and m["id"] not in ids:
+        return [Finding("error", p, f"{k}: {r} does not resolve within this board")]
+    return []
+
+
+def _check_comments(p: str, body: str) -> list[Finding]:
+    out: list[Finding] = []
+    lines = body.splitlines()
+    h2 = [(i, l) for i, l in enumerate(lines) if l.startswith("## ")]
+    idx = [i for i, l in h2 if l.strip() == "## Comments"]
+    if not idx:
+        return out
+    if len(idx) > 1:
+        out.append(Finding("error", p, "more than one ## Comments section"))
+    start = idx[0]
+    if any(i > start for i, _ in h2):
+        out.append(Finding("error", p, "## Comments must be the last level-2 section"))
+    for i in range(start + 1, len(lines)):
+        l = lines[i]
+        if l.startswith("### ") and not COMMENT_RE.match(l):
+            out.append(Finding("error", p, f"line {i + 1}: comment heading does not match '### <timestamp> <actor> [k=v ...]'"))
+    return out
+
+
+def validate(root: Path) -> list[Finding]:
+    board, findings = load_board(root)
+    if board is None:
+        return findings
+    issues, more = scan_issues(root, board)
+    findings += more
+    seen: dict[str, Path] = {}
+    for it in issues:
+        if it.id in seen:
+            findings.append(Finding("error", str(it.path), f"duplicate id {it.id} (also {seen[it.id]})"))
+        seen[it.id] = it.path
+    ids = set(seen)
+    key = board.get("key") if isinstance(board.get("key"), str) else None
+    for it in issues:
+        findings += check_issue(it, ids, key)
+    findings += check_comments_dir(root, ids)
+    if board.get("_comments_mode") == "sidecar":
+        for it in issues:
+            if "\n## Comments" in it.body or it.body.startswith("## Comments"):
+                findings.append(Finding("warn", str(it.path),
+                    "inline ## Comments on a board declaring comments: sidecar (spec 4.3)"))
+    kinds = board.get("_kinds")
+    if kinds is not None:
+        by_id = {it.id: it for it in issues}
+        for it in issues:
+            k = it.front.get("kind")
+            if k is not None and k not in kinds:
+                findings.append(Finding("error", str(it.path), f"kind {k!r} is not declared in board.md kinds"))
+            parent = it.front.get("parent")
+            if isinstance(parent, str) and k is not None:
+                pm = REF_RE.match(parent)
+                pit = by_id.get(pm["id"]) if pm else None
+                if pit is not None:
+                    pk = pit.front.get("kind")
+                    if pk in kinds and k not in kinds[pk]:
+                        findings.append(Finding("error", str(it.path), f"kind {k!r} may not be a child of {pk!r} (board.md kinds)"))
+    return findings
+
+
+def cmd_validate(root: Path) -> int:
+    findings = validate(root)
+    for f in findings:
+        print(f)
+    errors = sum(1 for f in findings if f.level == "error")
+    n = sum(1 for f in (root / "issues").rglob("*.md") if f.name not in RESERVED_FILES) if (root / "issues").is_dir() else 0
+    c = sum(1 for f in (root / "comments").rglob("*.md") if f.name not in RESERVED_FILES) if (root / "comments").is_dir() else 0
+    print(f"{root}: {n} issue file(s), {c} comment file(s), {errors} error(s), {len(findings) - errors} warning(s)")
+    return 1 if errors else 0
+
+
+def cmd_ls(root: Path, column: str | None) -> int:
+    board, findings = load_board(root)
+    if board is None:
+        print(findings[0]); return 1
+    issues, _ = scan_issues(root, board)
+    for col in board["_column_names"]:
+        if column and col != column:
+            continue
+        rows = [i for i in issues if i.column == col]
+        print(f"{col} ({len(rows)})")
+        for i in rows:
+            front, _, _ = split_frontmatter(i.path.read_text(encoding="utf-8"))
+            title = (front or {}).get("title", i.slug)
+            print(f"  {i.id}  {title}")
+    return 0
+
+
+def cmd_new(root: Path, column: str, title: str) -> int:
+    board, findings = load_board(root)
+    if board is None:
+        print(findings[0]); return 1
+    if column not in board["_column_names"]:
+        print(f"error: {column!r} is not a declared column"); return 1
+    d = root / "issues" / column
+    d.mkdir(parents=True, exist_ok=True)
+    now = datetime.now(timezone.utc).strftime("%Y-%m-%dT%H:%M:%SZ")
+    iid = new_id()
+    path = d / f"{slugify(title)}-{iid}.md"
+    key = board.get("key")
+    res = f"resource: oif:{key}/{iid}\n" if isinstance(key, str) else ""
+    path.write_text(f"---\ntype: issue\n{res}title: {yaml.safe_dump(title).strip()}\ncreated: {now}\n---\n\n", encoding="utf-8")
+    print(path)
+    return 0
+
+
+def cmd_index(root: Path) -> int:
+    """Write an OKF-shaped root index.md linking board.md and every column.md."""
+    board, findings = load_board(root)
+    if board is None:
+        print(findings[0]); return 1
+    title = board.get("title") or "Board"
+    lines = ['---', 'okf_version: "0.2"', '---', f"# {title}", "", "## Board", "",
+             f"- [{title}](board.md) — columns, kinds and charter", "", "## Columns", ""]
+    for col in board["_column_names"]:
+        cm = root / "issues" / col / "column.md"
+        desc = ""
+        if cm.is_file():
+            front, _, _ = split_frontmatter(cm.read_text(encoding="utf-8"))
+            desc = (front or {}).get("description", "")
+        lines.append(f"- [{col}](issues/{col}/column.md)" + (f" — {desc}" if desc else ""))
+    (root / "index.md").write_text("\n".join(lines) + "\n", encoding="utf-8")
+    print(root / "index.md")
+    return 0
+
+
+def main(argv: list[str] | None = None) -> int:
+    args = list(sys.argv[1:] if argv is None else argv)
+    if not args or args[0] in ("-h", "--help"):
+        print(__doc__.strip()); return 0
+    cmd, rest = args[0], args[1:]
+    if cmd == "id":
+        print(new_id()); return 0
+    if cmd == "validate":
+        return cmd_validate(Path(rest[0] if rest else "."))
+    if cmd == "ls":
+        return cmd_ls(Path(rest[0] if rest else "."), rest[1] if len(rest) > 1 else None)
+    if cmd == "index":
+        return cmd_index(Path(rest[0] if rest else "."))
+    if cmd == "new":
+        if len(rest) < 3:
+            print("usage: oifmd new BOARD COLUMN TITLE"); return 2
+        return cmd_new(Path(rest[0]), rest[1], " ".join(rest[2:]))
+    print(f"unknown command {cmd!r}\n\n{__doc__.strip()}"); return 2

oifmd-0.1.0.dev0/src/oifmd.egg-info/PKG-INFO

@@ -0,0 +1,136 @@
+Metadata-Version: 2.4
+Name: oifmd
+Version: 0.1.0.dev0
+Summary: Open Issue Format (OIF) validator and tools
+License: Apache-2.0
+Project-URL: Homepage, https://oif.md
+Project-URL: Source, https://github.com/oifmd/oifmd
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pyyaml>=6
+Dynamic: license-file
+
+# Open Issue Format (OIF)
+
+**Issues as files.** A directory of Markdown files that any agent or
+human can run as a board with `ls`, `cat` and `git mv`. No tool required.
+
+- **Spec:** [SPEC.md](SPEC.md) · version 0.1 (draft)
+- **Site:** https://oif.md
+- **Package:** `oifmd` (validator and converters)
+
+## Sixty-second tour
+
+```
+board.md
+issues/
+├── backlog/
+│   ├── column.md
+│   └── add-jira-importer-nkhnsk.md
+├── doing/
+│   ├── column.md
+│   └── fix-login-redirect-loop-7k2x9m.md
+└── done/
+    ├── column.md
+    └── write-spec-outline-h87456.md
+```
+
+The directory is the status. The filename is the identity. Moving an
+issue is `git mv issues/doing/fix-login-redirect-loop-7k2x9m.md issues/done/`.
+
+`issues/doing/fix-login-redirect-loop-7k2x9m.md`:
+
+```markdown
+---
+type: issue
+resource: oif:app/7k2x9m
+title: Login form rejects passwords containing "!"
+kind: bug
+priority: high
+assignees: [coder/1.4]
+requested_by: human:sam
+tags: [auth]
+created: 2026-09-13T03:10:00Z
+---
+
+Submitting a correct password with `!` clears the form and shows
+"invalid credentials". Expected: login succeeds.
+
+## Acceptance Criteria
+
+- [x] Reproduce with a failing test
+- [ ] Fix without changing the hashing path
+
+```
+
+Comments are separate files, one per comment, keyed by the issue's id:
+
+`comments/7k2x9m/k3n2wp.md`
+
+```markdown
+---
+type: comment
+at: 2026-09-13T04:12:00Z
+by: human:sam
+kind: verdict
+result: changes_requested
+---
+
+Keep the strip for whitespace only.
+```
+
+Read an issue and its whole history with one command:
+
+```sh
+cat issues/*/*-7k2x9m.md comments/7k2x9m/*.md
+```
+
+## Why
+
+Every git-native tracker (Backlog.md, git-issues, beaver-backlog, beads)
+converged on Markdown plus frontmatter, one file per issue. None
+published the format separately from the tool. OIF is the format,
+written down, with a validator, so issues outlive whichever tool wrote
+them and any agent can read them cold.
+
+Design rules that fall out of being agent-first and git-native:
+
+- **State is the directory.** A move is one atomic rename, not a
+  read-modify-write that two agents can trample.
+- **Identity is a random six-character id in the filename.** Two
+  branches can create issues at once and merge with no counter, no
+  scan, no renumbering. Sequential keys like `APP-2753` survive as
+  aliases.
+- **One comment is one file**, keyed by the issue's id. Two agents
+  commenting at once write two different paths, so nothing conflicts and
+  nothing is lost. Appending to a shared file does not survive concurrent
+  writers; see the changelog.
+- **Unknown keys are preserved.** Your tracker's extra fields round-trip.
+- **Every column has a `column.md`.** It keeps empty columns in git and
+  tells an arriving agent what belongs there and how to leave.
+- **The board declares its own vocabulary.** `board.md` lists the columns
+  and, optionally, the `kinds` an issue may have and which kinds may
+  contain which. Epic, story and task are one team's words, not the
+  format's. Ready `board.md` files for Kanban, Scrum and Shape Up are in
+  [`profiles/`](profiles/).
+
+An OIF board is a conforming [Open Knowledge Format](https://okf.md)
+bundle: same substrate, same actor convention, `type: issue` on every
+file. The one deliberate divergence, identity by id rather than by path,
+is spelled out in SPEC.md section 9. Trackers are platforms, OIF is the
+file.
+
+## This repository
+
+The roadmap for OIF itself lives in [`board/`](board/), in OIF.
+GitHub Issues stays open for conversation; accepted work lands in
+`board/issues/` with the GitHub number kept in `external_ids`.
+
+## Status
+
+0.1 is a draft. Expect 0.x to move.
+
+## License
+
+Apache-2.0.

oifmd-0.1.0.dev0/src/oifmd.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+LICENSE
+README.md
+pyproject.toml
+src/oifmd/__init__.py
+src/oifmd/__main__.py
+src/oifmd/cli.py
+src/oifmd.egg-info/PKG-INFO
+src/oifmd.egg-info/SOURCES.txt
+src/oifmd.egg-info/dependency_links.txt
+src/oifmd.egg-info/entry_points.txt
+src/oifmd.egg-info/requires.txt
+src/oifmd.egg-info/top_level.txt

oifmd-0.1.0.dev0/src/oifmd.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

oifmd-0.1.0.dev0/src/oifmd.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+oifmd = oifmd.cli:main

oifmd-0.1.0.dev0/src/oifmd.egg-info/requires.txt

@@ -0,0 +1 @@
+pyyaml>=6

oifmd-0.1.0.dev0/src/oifmd.egg-info/top_level.txt

@@ -0,0 +1 @@
+oifmd