Skip to content

Commit f41ab77

Browse files
manuel-lohmusmanuel-lohmus
committed
v2.0
1 parent b9c2507 commit f41ab77

6 files changed

Lines changed: 214 additions & 2 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
name: "Bug report"
2+
description: "Report a reproducible bug in data-context"
3+
title: "[Bug]: "
4+
labels: ["bug"]
5+
assignees: []
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for reporting a bug! Please fill out the form below as completely as possible to help us reproduce and fix the issue quickly.
11+
- type: checkboxes
12+
id: duplicates
13+
attributes:
14+
label: Is there an existing issue for this?
15+
description: Please search to see if an issue already exists for the problem you’re experiencing.
16+
options:
17+
- label: I have searched the existing issues
18+
required: true
19+
- type: input
20+
id: version
21+
attributes:
22+
label: data-context version
23+
description: Output of `npm ls data-context` or the version from package.json.
24+
placeholder: "e.g. 2.0.0"
25+
validations:
26+
required: true
27+
- type: input
28+
id: node
29+
attributes:
30+
label: Node.js version
31+
placeholder: "e.g. v18.20.3, v20.16.0"
32+
- type: input
33+
id: browser
34+
attributes:
35+
label: Browser and version (if applicable)
36+
placeholder: "e.g. Chrome 128, Firefox 127"
37+
- type: input
38+
id: os
39+
attributes:
40+
label: OS
41+
placeholder: "e.g. Windows 11, macOS 14.5, Ubuntu 24.04"
42+
- type: textarea
43+
id: description
44+
attributes:
45+
label: Describe the bug
46+
description: A clear and concise description of what the bug is.
47+
placeholder: "What happened? What did you expect to happen?"
48+
validations:
49+
required: true
50+
- type: textarea
51+
id: repro-steps
52+
attributes:
53+
label: Steps to reproduce
54+
description: Provide exact steps to reproduce the issue.
55+
placeholder: |
56+
1. Using code snippet below
57+
2. Run `node index.test.js`
58+
3. Observe error message...
59+
validations:
60+
required: true
61+
- type: textarea
62+
id: code
63+
attributes:
64+
label: Minimal reproducible code
65+
description: Provide a minimal snippet (no external deps) that reproduces the issue.
66+
render: javascript
67+
placeholder: |
68+
const DC = require('data-context');
69+
const { parse, createDataContext } = DC;
70+
const ctx = parse('{"count":0}', createDataContext);
71+
// ...
72+
- type: textarea
73+
id: expected
74+
attributes:
75+
label: Expected behavior
76+
placeholder: "What should have happened?"
77+
validations:
78+
required: true
79+
- type: textarea
80+
id: actual
81+
attributes:
82+
label: Actual behavior
83+
placeholder: "What actually happened?"
84+
validations:
85+
required: true
86+
- type: textarea
87+
id: logs
88+
attributes:
89+
label: Logs / stack trace
90+
render: text
91+
placeholder: "Paste relevant logs or stack traces here."
92+
- type: textarea
93+
id: extras
94+
attributes:
95+
label: Additional context / screenshots
96+
placeholder: "Anything else relevant to the issue."
97+
- type: checkboxes
98+
id: contribution
99+
attributes:
100+
label: Are you willing to submit a PR?
101+
options:
102+
- label: Yes, I’m willing to submit a PR to fix this

‎.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 (README)
4+
url: https://github.com/manuel-lohmus/data-context#readme
5+
about: Read the usage guide, examples, and API overview.
6+
- name: npm package
7+
url: https://www.npmjs.com/package/data-context
8+
about: Install instructions and version history.

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
name: "Feature request"
2+
description: "Suggest an idea or improvement for data-context"
3+
title: "[Feature]: "
4+
labels: ["enhancement"]
5+
assignees: []
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for your suggestion! Please describe the problem this feature would solve and your proposed solution.
11+
- type: input
12+
id: version
13+
attributes:
14+
label: data-context version
15+
placeholder: "e.g. 2.0.0"
16+
- type: textarea
17+
id: problem
18+
attributes:
19+
label: Problem to solve
20+
description: What is the user problem or use case?
21+
placeholder: "When I try to ..., it is hard to ..."
22+
validations:
23+
required: true
24+
- type: textarea
25+
id: solution
26+
attributes:
27+
label: Proposed solution
28+
description: Describe your preferred solution.
29+
placeholder: "Add an option to ..."
30+
validations:
31+
required: true
32+
- type: textarea
33+
id: api
34+
attributes:
35+
label: API design (if applicable)
36+
description: Describe the API, including TypeScript signatures if possible.
37+
render: typescript
38+
placeholder: |
39+
interface Options { /* ... */ }
40+
createDataContext.stringify(value, null, 2, { /* ... */ })
41+
- type: checkboxes
42+
id: breaking
43+
attributes:
44+
label: Breaking change?
45+
options:
46+
- label: This change would break existing users
47+
- type: textarea
48+
id: alternatives
49+
attributes:
50+
label: Alternatives considered
51+
placeholder: "Describe any alternative solutions or features you’ve considered."
52+
- type: textarea
53+
id: extras
54+
attributes:
55+
label: Additional context
56+
placeholder: "Links, references, or related issues."

‎.github/ISSUE_TEMPLATE/question.yml‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
name: "Question"
2+
description: "Ask a question about using data-context"
3+
title: "[Question]: "
4+
labels: ["question"]
5+
assignees: []
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Please provide enough context so we can help quickly. If this is a bug, use the Bug report template instead.
11+
- type: input
12+
id: version
13+
attributes:
14+
label: data-context version
15+
placeholder: "e.g. 2.0.0"
16+
- type: textarea
17+
id: question
18+
attributes:
19+
label: Your question
20+
placeholder: "Describe what you need help with."
21+
validations:
22+
required: true
23+
- type: textarea
24+
id: code
25+
attributes:
26+
label: Relevant code snippet
27+
render: javascript
28+
placeholder: |
29+
const DC = require('data-context');
30+
// ...
31+
- type: input
32+
id: runtime
33+
attributes:
34+
label: Runtime environment
35+
description: "Node.js version and/or Browser + version"
36+
placeholder: "e.g. Node v20.16.0; Chrome 128"
37+
- type: input
38+
id: os
39+
attributes:
40+
label: OS
41+
placeholder: "e.g. Windows 11, macOS 14.5, Ubuntu 24.04"
42+
- type: textarea
43+
id: extras
44+
attributes:
45+
label: Additional context
46+
placeholder: "Anything else you want to add."

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Watch data changes in the browser and node.js
1414
- [🧪 Testing](#-testing)
1515
- [🚀 Usage](#-usage)
1616
- [📖 API Reference](#-api-reference)
17-
- [📜 License](#-license)
17+
- [📜 License - MIT](#-license)
1818

1919
<p align="right"><a href="#data-context">Back to top ↑</a></p>
2020

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "data-context",
33
"description": "Watch data changes in the browser and node.js",
4-
"version": "2.0.0-rc.2",
4+
"version": "2.0.0",
55
"license": "MIT",
66
"keywords": [
77
"conextra",

0 commit comments

Comments
 (0)