Skip to content

breaking change: a third project type, and the README rules only a render reveals - #1

Merged
obarlik merged 2 commits into
mainfrom
standards/research-line-type
Aug 29, 2026
Merged

obarlik merged 2 commits into
mainfrom
standards/research-line-type

Conversation

@obarlik

@obarlik obarlik commented Aug 29, 2026

Copy link
Copy Markdown
Member

Two changes, one per commit.

A third project type. The existing two assume something ships: a
library installed by other software, or an application opened by a
person. A repo carrying a method, the pipeline that runs it, and an
honest verdict about whether it works is neither. Forcing it into the
library skeleton makes the README promise things it cannot keep — a
five-line quick example when there is nothing to install, a family
table when there is no registry namespace. RESEARCH-LINE.md names
those two bullets inapplicable, says what replaces them, and keeps
every other vitrine rule.

Rendering rules in §7.1. Five things were true of our READMEs for
as long as they had been written and none were visible in the markdown
source: the README is not the fold (~1080 px down, under the file list
and About box — so description and topics, which are settings and not
files, are the most-read text); two blockquote lines collapse into one;
a dead badge still looks like a signal; a fence clips rather than
wraps; an indented block gets no highlighting. Found by rendering
through gh api /markdown and looking. They are properties of GitHub,
so they sit in §7.1, not in one project type.

Ripple: every product repo's README is now measured against §7.1's
rendering rules. Nothing existing becomes invalid — the two annotated
bullets are narrowed, not removed.

TR mirror updated for both. Known gap, not addressed here:
STANDARDS.tr.md has no §13 "Layered conventions" section at all
(its §13 is "Aktif repolar"), so the layer-table row has no TR home.

Codechu added 2 commits August 29, 2026 16:21
The two existing types assume something ships: a library installed by
other software, or an application opened by a person. A repository
that carries a method, the pipeline that runs it, and an honest verdict
about whether it works is neither, and forcing it into the library
skeleton produced a README that had to promise things it could not
keep — a five-line quick example when there is nothing to install, a
family table when there is no registry namespace.

RESEARCH-LINE.md names those two bullets as inapplicable, states what
replaces them, and keeps every other vitrine rule. Its own rules each
carry the incident that produced them; a rule with no incident behind
it is a guess, and this is where that shows.
Five things were true of Codechu READMEs for as long as they had been
written, and none of them were visible while reading the markdown: the
README is not the fold on a repository page (it begins around 1080 px
down, under the file listing and the About box, so description and
topics — settings, not files — are the most-read text); two blockquote
lines in one paragraph collapse into one; a badge can be a dead image
and still look like a signal; a code fence clips rather than wraps, so
the first command a reader saw was cut mid-word; an indented block gets
no highlighting.

All five were found by rendering through `gh api /markdown` and looking
at the page. They belong in §7.1 rather than in one project type,
because they are properties of GitHub, not of what the repo contains.
Copilot AI lite review requested due to automatic review settings August 29, 2026 13:34
@obarlik
obarlik merged commit 21526b0 into main Aug 29, 2026
1 check passed
@obarlik
obarlik deleted the standards/research-line-type branch August 29, 2026 13:34

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a third project type (“research line”) to Codechu’s project taxonomy and updates README “vitrine” standards with GitHub-rendering-specific rules that only become apparent when viewing the rendered README.

Changes:

  • Introduces project-type/RESEARCH-LINE.md defining language-agnostic conventions for “research line” repositories and clarifying which §7.1 README bullets do not apply.
  • Extends STANDARDS §7.1 (EN + TR) with measured GitHub rendering rules (fold location, blockquote line collapse, dead badges, code-fence clipping, and indented-block highlighting).
  • Updates the project-type index/table and layered-conventions text to include “research line” alongside library and application.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

File Description
STANDARDS.md Adds research-line exceptions to two README vitrine bullets; adds measured GitHub rendering rules; updates layered conventions to include research lines.
STANDARDS.tr.md Turkish mirror: adds research-line exceptions and the measured GitHub rendering rules in §7.1.
project-type/RESEARCH-LINE.md New project-type spec describing research-line repos, README skeleton, and measurement-derived presentation rules.
project-type/README.md Adds “Research line” to the project-type matrix and directory tree; updates intro text to reflect >2 types.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants