Skip to content

Commit 99bb99c

Browse files
committed
Add repository maintenance metadata
1 parent 0ef4584 commit 99bb99c

3 files changed

Lines changed: 59 additions & 8 deletions

File tree

CONTRIBUTING.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Contributing
2+
3+
Thanks for taking the time to improve this package.
4+
5+
## Local setup
6+
7+
```bash
8+
npm install
9+
npm run typecheck
10+
npm test
11+
npm run build
12+
```
13+
14+
## Pull requests
15+
16+
Please keep changes focused and include tests for behavior changes. Small API improvements are welcome when they keep the package predictable, typed, and easy to use in both Node and browser-oriented tooling.
17+
18+
Before opening a pull request, run:
19+
20+
```bash
21+
npm run typecheck
22+
npm test
23+
npm run build
24+
```
25+
26+
## Issues
27+
28+
When reporting a bug, include:
29+
30+
- the package version;
31+
- the input that failed;
32+
- the expected output;
33+
- the actual output or diagnostic code.
34+
35+
Please avoid broad feature requests that would turn the package into a large framework. These utilities are intentionally small and focused.

SECURITY.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Security Policy
2+
3+
## Reporting a Vulnerability
4+
5+
If you find a security issue, please report it privately when GitHub security advisories are available for this repository. If private advisories are not available, open a minimal issue that describes the affected package and version without publishing exploit details.
6+
7+
Please include:
8+
9+
- the affected package and version;
10+
- the smallest input or scenario needed to understand the issue;
11+
- the impact you believe it has;
12+
- whether the issue affects Node, browsers, or both.
13+
14+
These packages are small developer utilities, but parser and renderer bugs can still matter. Reports about denial-of-service behavior, unsafe output, or misleading validation are welcome.

package.json

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,16 @@
22
"name": "json-html-kit",
33
"version": "0.4.2",
44
"description": "Render arbitrary JSON as safe, themed, human-friendly HTML tables.",
5+
"keywords": [
6+
"json",
7+
"html",
8+
"json-viewer",
9+
"json-renderer",
10+
"table",
11+
"typescript",
12+
"browser",
13+
"developer-tools"
14+
],
515
"type": "module",
616
"sideEffects": false,
717
"license": "MPL-2.0",
@@ -14,14 +24,6 @@
1424
"url": "https://github.com/Recoveredd/json-html-kit/issues"
1525
},
1626
"homepage": "https://github.com/Recoveredd/json-html-kit#readme",
17-
"keywords": [
18-
"json",
19-
"html",
20-
"table",
21-
"renderer",
22-
"viewer",
23-
"typescript"
24-
],
2527
"exports": {
2628
".": {
2729
"types": "./dist/index.d.ts",

0 commit comments

Comments
 (0)