Skip to content

Commit abbcf37

Browse files
committed
Harden quality checks and documentation
1 parent b021c21 commit abbcf37

6 files changed

Lines changed: 133 additions & 0 deletions

File tree

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
name: Bug report
3+
about: Report reproducible incorrect behavior in csvtable
4+
title: "[bug] "
5+
labels: bug
6+
assignees: ""
7+
---
8+
9+
## What happened?
10+
11+
Describe the behavior and why it is incorrect.
12+
13+
## Minimal reproduction
14+
15+
```text
16+
Paste the smallest input, command, or code sample that reproduces the issue.
17+
```
18+
19+
## Expected behavior
20+
21+
What should happen instead?
22+
23+
## Environment
24+
25+
- OS:
26+
- Python/Node version:
27+
- Repository commit or version:
28+
29+
## Notes
30+
31+
Include edge cases, security impact, or related standards references if useful.
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
name: Feature request
3+
about: Propose a focused improvement to csvtable
4+
title: "[feature] "
5+
labels: enhancement
6+
assignees: ""
7+
---
8+
9+
## Problem
10+
11+
What concrete user or developer problem should this solve?
12+
13+
## Proposed shape
14+
15+
Describe the smallest API, CLI, example, or documentation change that would
16+
solve it.
17+
18+
## Alternatives
19+
20+
What can users do today? What existing library or standard should this be
21+
compared against?
22+
23+
## Fit with the lab
24+
25+
Explain why this belongs in a small, readable, auditable project.

.github/pull_request_template.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
## Summary
2+
3+
Describe what changed in `csvtable` and why.
4+
5+
## Verification
6+
7+
- [ ] Tests pass locally.
8+
- [ ] Type/lint/build checks pass where applicable.
9+
- [ ] README, examples, roadmap, or changelog updated if behavior changed.
10+
- [ ] No fake package, benchmark, badge, download, or adoption claims added.
11+
12+
## Risk
13+
14+
Call out compatibility, security, parsing, performance, or migration risks.

CHANGELOG.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Changelog
2+
3+
All notable changes to `csvtable` will be tracked here.
4+
5+
This project follows an honest-source rule: no package publication, benchmark,
6+
download, or adoption claim is added unless it has been verified.
7+
8+
## Unreleased
9+
10+
- Added the shared lab maintainer surface: code of conduct, changelog, roadmap,
11+
issue templates, and pull request template.
12+
- Clarified source-checkout installation guidance where package-registry
13+
publication has not been verified.
14+
- Removed static or unverifiable status badges.

CODE_OF_CONDUCT.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Code of Conduct
2+
3+
This repository is part of the No-Dependency AI + Systems Lab. The goal is to
4+
make small engineering artifacts easier to read, run, audit, and improve.
5+
6+
## Expected Behavior
7+
8+
- Be precise, kind, and technical.
9+
- Critique code, documentation, tests, and assumptions rather than people.
10+
- Prefer reproducible examples over vague claims.
11+
- Disclose security-sensitive issues responsibly through `SECURITY.md`.
12+
13+
## Unacceptable Behavior
14+
15+
- Harassment, personal attacks, discriminatory language, or intimidation.
16+
- Publishing secrets, private data, or exploit details before maintainers have a
17+
chance to respond.
18+
- Spam, star-bait, or promotional noise unrelated to `csvtable`.
19+
20+
## Enforcement
21+
22+
Maintainers may edit, hide, or remove issues, discussions, comments, or pull
23+
requests that violate this code. Repeated or severe violations may lead to a
24+
block from the project.

ROADMAP.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Roadmap
2+
3+
`csvtable`: Pretty-print CSV/TSV (or any rows) as aligned ASCII / Unicode / Markdown / plain tables — column-width inference, per-column align, 3-mode truncation, wide-char width..
4+
5+
## Near Term
6+
7+
- Keep the README specific: audience, thesis, quick demo, limitations, and
8+
source-checkout install instructions.
9+
- Keep edge-case tests near the code they protect.
10+
- Keep CI aligned with the local commands: `pytest` and `python -m build` where
11+
applicable.
12+
13+
## Release Readiness
14+
15+
- Verify package metadata before publishing anywhere.
16+
- Add a release tag only after tests, type checks, build/pack checks, and docs
17+
are all current.
18+
- Do not add download, usage, benchmark, or adoption claims without evidence.
19+
20+
## Later
21+
22+
- Add small examples for the most common workflow.
23+
- Add benchmark or conformance scripts only where performance or standards
24+
compliance is part of the value proposition.
25+
- Consolidate with a sibling repo if the audience and API overlap too much.

0 commit comments

Comments
 (0)