Skip to content

Commit c3aced8

Browse files
Merge pull request #3 from sergeyshmakov/2026-05-13-package-api-amd-repo-polish
2026 05 13 package api and repo polish
2 parents 9bc0b71 + 27f3347 commit c3aced8

55 files changed

Lines changed: 19315 additions & 9707 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/CODE_OF_CONDUCT.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Code of Conduct
2+
3+
This project adopts the [Contributor Covenant 2.1](https://www.contributor-covenant.org/version/2/1/code_of_conduct/) code of conduct.
4+
5+
In brief:
6+
7+
- Be respectful and constructive.
8+
- No harassment, personal attacks, or exclusionary behavior.
9+
- Assume good intent; ask questions before drawing conclusions.
10+
11+
## Reporting
12+
13+
Report violations to [shmakov@konturnomad.am](mailto:shmakov@konturnomad.am). Reports are reviewed within 7 days and treated with discretion.
14+
15+
## Enforcement
16+
17+
Violations may result in comment removal, temporary restriction, or permanent ban from the project, depending on severity and context.

.github/ISSUE_TEMPLATE/bug.yml

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: Bug report
2+
description: Report a defect or unexpected behavior
3+
labels: ["bug"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Before submitting, check [existing issues](https://github.com/sergeyshmakov/data-path/issues) to avoid duplicates.
9+
10+
- type: textarea
11+
id: description
12+
attributes:
13+
label: Description
14+
description: What happened, and what did you expect?
15+
validations:
16+
required: true
17+
18+
- type: textarea
19+
id: reproduction
20+
attributes:
21+
label: Minimal reproduction
22+
description: A self-contained TypeScript snippet that demonstrates the issue.
23+
render: ts
24+
validations:
25+
required: true
26+
27+
- type: input
28+
id: version
29+
attributes:
30+
label: Package version
31+
placeholder: "1.0.0"
32+
validations:
33+
required: true
34+
35+
- type: input
36+
id: ts-version
37+
attributes:
38+
label: TypeScript version
39+
placeholder: "5.5.0"
40+
validations:
41+
required: true

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Documentation
4+
url: https://sergeyshmakov.github.io/data-path/
5+
about: Browse the full documentation site first — your question may already be answered.
6+
- name: Discussions
7+
url: https://github.com/sergeyshmakov/data-path/discussions
8+
about: Usage questions, ideas, and general conversation.

.github/ISSUE_TEMPLATE/feature.yml

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: Feature request
2+
description: Propose a new capability or API change
3+
labels: ["enhancement"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Please open an issue before writing code for large features — this avoids wasted effort if the design needs adjusting.
9+
10+
- type: textarea
11+
id: problem
12+
attributes:
13+
label: Problem statement
14+
description: What is missing or painful today?
15+
validations:
16+
required: true
17+
18+
- type: textarea
19+
id: solution
20+
attributes:
21+
label: Proposed solution
22+
description: What would you like to see? A code sketch is welcome.
23+
validations:
24+
required: true
25+
26+
- type: textarea
27+
id: alternatives
28+
attributes:
29+
label: Alternatives considered
30+
description: Other approaches you considered, and why you ruled them out.

.github/dependabot.yml

Lines changed: 39 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ updates:
55
directory: "/"
66
schedule:
77
interval: "monthly"
8-
day: "monday"
98
time: "06:00"
109
timezone: "UTC"
10+
allow:
11+
- dependency-type: "direct"
1112
open-pull-requests-limit: 5
1213
labels:
1314
- "dependencies"
14-
dependency-type: "direct"
1515
groups:
1616
npm-production:
1717
dependency-type: "production"
@@ -20,3 +20,40 @@ updates:
2020
ignore:
2121
- dependency-name: "@types/node*"
2222
versions: [ ">=24" ]
23+
- dependency-name: "lint-staged"
24+
versions: [ ">=17" ]
25+
- dependency-name: "typescript"
26+
versions: [ ">=6" ]
27+
28+
- package-ecosystem: "npm"
29+
directory: "/docs"
30+
schedule:
31+
interval: "monthly"
32+
time: "06:00"
33+
timezone: "UTC"
34+
allow:
35+
- dependency-type: "direct"
36+
open-pull-requests-limit: 1
37+
labels:
38+
- "dependencies"
39+
groups:
40+
docs-dependencies:
41+
patterns: ["*"]
42+
ignore:
43+
- dependency-name: "lint-staged"
44+
versions: [ ">=17" ]
45+
- dependency-name: "typescript"
46+
versions: [ ">=6" ]
47+
48+
- package-ecosystem: "github-actions"
49+
directory: "/"
50+
schedule:
51+
interval: "monthly"
52+
time: "06:00"
53+
timezone: "UTC"
54+
open-pull-requests-limit: 1
55+
labels:
56+
- "dependencies"
57+
groups:
58+
github-actions:
59+
patterns: ["*"]

.github/pull_request_template.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
## What does this PR do?
2+
3+
<!-- A concise description. Link any related issue with "Closes #123" or "Fixes #123". -->
4+
5+
## How to test
6+
7+
<!-- Steps to reproduce or verify the change. -->
8+
9+
## Checklist
10+
11+
- [ ] Tests added or updated
12+
- [ ] Docs updated (if public API changed)
13+
- [ ] Commit messages follow [Conventional Commits](https://www.conventionalcommits.org/)

.github/workflows/deploy-docs.yml

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: Deploy Docs
2+
3+
on:
4+
push:
5+
branches: [main]
6+
paths: ["docs/**"]
7+
workflow_dispatch:
8+
9+
permissions:
10+
contents: read
11+
pages: write
12+
id-token: write
13+
14+
concurrency:
15+
group: pages
16+
cancel-in-progress: false
17+
18+
jobs:
19+
build:
20+
name: Build
21+
runs-on: ubuntu-latest
22+
steps:
23+
- uses: actions/checkout@v4
24+
with:
25+
# Full history so Starlight's `lastUpdated` (git log per file) is accurate.
26+
fetch-depth: 0
27+
- uses: actions/setup-node@v4
28+
with:
29+
node-version: lts/*
30+
- name: Install dependencies
31+
working-directory: docs
32+
run: npm ci
33+
- name: Build docs
34+
working-directory: docs
35+
run: npm run build
36+
- uses: actions/upload-pages-artifact@v3
37+
with:
38+
path: docs/dist
39+
40+
deploy:
41+
name: Deploy
42+
needs: build
43+
runs-on: ubuntu-latest
44+
environment:
45+
name: github-pages
46+
url: ${{ steps.deployment.outputs.page_url }}
47+
steps:
48+
- id: deployment
49+
uses: actions/deploy-pages@v4

.github/workflows/publish.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@ jobs:
1313
pull-requests: write
1414
id-token: write
1515
steps:
16-
- uses: actions/checkout@v4
16+
- uses: actions/checkout@v6
1717
with:
1818
fetch-depth: 0
1919
fetch-tags: true
20-
- uses: actions/setup-node@v4
20+
- uses: actions/setup-node@v6
2121
with:
2222
node-version: 'lts/*'
2323

.husky/pre-commit

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1+
npx lint-staged
12
npm test
2-
npx @biomejs/biome check --write --staged --no-errors-on-unmatched

.lintstagedrc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"*.{js,jsx,ts,tsx,json,jsonc,md,mdx,css,yml,yaml}": "biome check --write --no-errors-on-unmatched"
3+
}

0 commit comments

Comments
 (0)