Skip to content

Commit 6cdd28c

Browse files
committed
Include reference example generator in docs:all and highlight it in readme
1 parent 4621f58 commit 6cdd28c

14 files changed

Lines changed: 1592 additions & 327 deletions

File tree

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Bug Report
3+
about: Report a bug to help us improve
4+
labels: bug
5+
---
6+
7+
## Describe the Bug
8+
9+
A clear description of what the bug is.
10+
11+
## To Reproduce
12+
13+
Steps to reproduce the behavior:
14+
15+
1. Run `...`
16+
2. With config `...`
17+
3. See error
18+
19+
## Expected Behavior
20+
21+
What you expected to happen.
22+
23+
## Error Output
24+
25+
```
26+
Paste any error messages or unexpected output here.
27+
```
28+
29+
## Environment
30+
31+
- **Node.js version:** (e.g., 20.10.0)
32+
- **Package version:** (e.g., 1.0.0-pre.0)
33+
- **OS:** (e.g., macOS 15, Ubuntu 24.04)
34+
- **Package manager:** (npm / pnpm / yarn)
35+
36+
## Additional Context
37+
38+
Any other context — config files, feature files, annotation examples — that helps explain the problem.
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
name: Feature Request
3+
about: Suggest a new feature or improvement
4+
labels: enhancement
5+
---
6+
7+
## Is your feature request related to a problem?
8+
9+
A clear description of the problem. Ex. "I'm always frustrated when..."
10+
11+
## Describe the Solution You'd Like
12+
13+
A clear description of what you want to happen.
14+
15+
## Describe Alternatives You've Considered
16+
17+
Any alternative solutions or features you've considered.
18+
19+
## Additional Context
20+
21+
Any other context — use cases, examples, screenshots — that helps explain the request.

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8+
## [Unreleased]
9+
810
## [1.0.0-pre.0] - 2026-02-21
911

1012
First npm-published pre-release for monorepo validation.
@@ -24,3 +26,6 @@ First npm-published pre-release for monorepo validation.
2426
- `dist/` removed from git tracking -- built fresh during publish
2527
- `@libar-dev/modular-claude-md` moved from dependencies to devDependencies
2628
- Package size trimmed (removed self-referential docs from tarball)
29+
30+
[Unreleased]: https://github.com/libar-dev/delivery-process/compare/v1.0.0-pre.0...HEAD
31+
[1.0.0-pre.0]: https://github.com/libar-dev/delivery-process/releases/tag/v1.0.0-pre.0

CONTRIBUTING.md

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
# Contributing to @libar-dev/delivery-process
2+
3+
We welcome contributions! This guide covers how to get started.
4+
5+
## Prerequisites
6+
7+
- **Node.js** >= 18.0.0
8+
- **pnpm** (recommended package manager)
9+
- ESM project (`"type": "module"`)
10+
11+
## Getting Started
12+
13+
```bash
14+
# Fork the repo on GitHub, then:
15+
git clone https://github.com/<your-username>/delivery-process.git
16+
cd delivery-process
17+
pnpm install
18+
pnpm build && pnpm test
19+
```
20+
21+
## Development Workflow
22+
23+
```bash
24+
pnpm build # Compile TypeScript
25+
pnpm dev # Watch mode
26+
pnpm test # Run all tests
27+
pnpm test <pattern> # Run specific tests
28+
pnpm typecheck # Type check without emit
29+
pnpm lint # ESLint
30+
pnpm format:check # Prettier check
31+
```
32+
33+
## Testing Policy
34+
35+
This package enforces **strict Gherkin-only testing**:
36+
37+
- All tests are `.feature` files with step definitions in `.steps.ts`
38+
- No `.test.ts` files — exception-free policy
39+
- Edge cases use `Scenario Outline` with Examples tables
40+
- Feature files live in `tests/features/`, step defs in `tests/steps/`
41+
42+
A package that generates documentation from `.feature` files should demonstrate that Gherkin is sufficient for testing.
43+
44+
## Pre-commit Hooks
45+
46+
The project uses Husky with lint-staged. On every commit:
47+
48+
- ESLint + Prettier auto-fix on staged `.ts` files
49+
- Prettier on staged `.json`, `.md`, `.yml` files
50+
51+
These run automatically — no manual setup needed after `pnpm install`.
52+
53+
## Making Changes
54+
55+
1. Create a branch from `main`
56+
2. Make your changes
57+
3. Run the full validation suite:
58+
```bash
59+
pnpm build && pnpm test && pnpm typecheck && pnpm lint && pnpm format:check
60+
```
61+
4. Commit with a clear message describing the "why"
62+
63+
## Pull Requests
64+
65+
- PRs target the `main` branch
66+
- CI runs on Node.js 18, 20, and 22
67+
- All checks (build, test, typecheck, lint, format) must pass
68+
- We review for consistency with the four-stage pipeline architecture (Scanner, Extractor, Transformer, Codec)
69+
70+
## Reporting Issues
71+
72+
- Use [GitHub Issues](https://github.com/libar-dev/delivery-process/issues)
73+
- For security vulnerabilities, see [SECURITY.md](SECURITY.md)
74+
75+
## Code of Conduct
76+
77+
Be respectful, constructive, and inclusive. We follow the [Contributor Covenant](https://www.contributor-covenant.org/version/2/1/code_of_conduct/).

0 commit comments

Comments
 (0)