Skip to content

Commit 190a19b

Browse files
committed
docs: public-ready README + templates, license; add issue/PR templates
1 parent 59827c4 commit 190a19b

9 files changed

Lines changed: 303 additions & 190 deletions

File tree

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
name: Bug report
3+
title: "fix: <short description>"
4+
labels: [bug]
5+
---
6+
7+
8+
**Describe the bug**
9+
A clear description of the problem.
10+
11+
12+
**Reproduction**
13+
Steps/code to reproduce (link to demo page if possible).
14+
15+
16+
**Expected behavior**
17+
18+
19+
**Environment**
20+
- formBuilder-ConditionalLogic version:
21+
- formBuilder version:
22+
- Browser/OS:
23+
24+
25+
**Additional context**
26+
Screenshots/logs.
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: Feature request
3+
title: "feat: <short description>"
4+
labels: [enhancement]
5+
---
6+
7+
8+
**Problem**
9+
What’s the use‑case?
10+
11+
12+
**Proposal**
13+
Describe the change, with examples/mockups.
14+
15+
16+
**Alternatives**
17+
Any workarounds?

.github/pull_request_template.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
## Summary
2+
3+
4+
- [ ] Feature / [ ] Fix / [ ] Docs / [ ] Chore
5+
6+
7+
## Changes
8+
-
9+
10+
11+
## Demo
12+
Link to `demo/` page or screenshots/GIFs.
13+
14+
15+
## Checklist
16+
- [ ] Tests added/updated (when available)
17+
- [ ] Docs updated (README/CHANGELOG)
18+
- [ ] Works in static UMD demo

CHANGELOG.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,29 @@
11
# Changelog
22

3-
## 0.1.0 — Initial release
4-
- Renderer with hydration: `setup(formEl, formData)`
5-
- Actions: show, hide, require, enable, disable
6-
- Operators: equals, notEquals, contains, startsWith, endsWith, gt, gte, lt, lte, isEmpty, notEmpty
7-
- Builder panel (JSON / ApplyTo / Group ID)
8-
- Logic Groups modal (toolbar helper)
9-
- Demos: builder, render (static), composed (builder JSON → render)
10-
11-
## 0.2.0 — Visual Editors
12-
- Builder: **Visual Rules Editor** (no-JSON) for per-field logic
13-
- Hooks: `getAvailableFields`, `getFieldValues` to populate field/value dropdowns
14-
- Builder: **Visual Groups Editor** (GUI) for reusable groups
15-
- Advanced (JSON) panels now wrapped and collapsed by default
16-
- Demo updated to wire hooks from current form JSON
17-
183

4+
## 0.2.2 — Public demos & polish
195

20-
# 4) CHANGELOG update
21-
Append a section for your new tag.
6+
* Add static UMD demos (`demo/builder-static.html`, `demo/render-static.html`)
7+
* Include built bundle in `dist/` for GitHub Pages
8+
* Builder UI polish: Advanced (JSON) panels collapsed by default, consistent headers
229

23-
### If tagging **0.2.1**
24-
```markdown
2510
## 0.2.1 — GUI polish + Advanced panels
2611
- Builder: Visual Rules Editor title moved outside dashed border (consistent with Advanced)
2712
- Builder: Per-field **Advanced (JSON)** panel added, wrapped and **collapsed by default**
2813
- Groups modal: **Visual Groups Editor** (GUI) added; Advanced (JSON) panel collapsed by default
2914
- Fix: guard against duplicate Visual Editor mounts
15+
16+
## 0.2.0 — Visual Editors
17+
- Builder: **Visual Rules Editor** (no-JSON) for per-field logic
18+
- Hooks: `getAvailableFields`, `getFieldValues` to populate field/value dropdowns
19+
- Builder: **Visual Groups Editor** (GUI) for reusable groups
20+
- Advanced (JSON) panels now wrapped and collapsed by default
21+
- Demo updated to wire hooks from current form JSON
22+
23+
## 0.1.0 — Initial release
24+
- Renderer with hydration: `setup(formEl, formData)`
25+
- Actions: show, hide, require, enable, disable
26+
- Operators: equals, notEquals, contains, startsWith, endsWith, gt, gte, lt, lte, isEmpty, notEmpty
27+
- Builder panel (JSON / ApplyTo / Group ID)
28+
- Logic Groups modal (toolbar helper)
29+
- Demos: builder, render (static), composed (builder JSON → render)

CODE_OF_CONDUCT.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# CODE_OF_CONDUCT.md
2+
3+
This project follows the [Contributor Covenant](https://www.contributor-covenant.org/) Code of Conduct. By participating, you agree to uphold a harassment‑free, inclusive environment. Reports: open an issue or contact the maintainers privately.
4+
5+

CONTRIBUTING.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# CONTRIBUTING.md
2+
3+
Thanks for considering a contribution! 🙌 This project welcomes fixes, features, docs, and examples.
4+
5+
## Developer Certificate of Origin (DCO)
6+
7+
We use the **Developer Certificate of Origin**. By contributing, you assert that you have the right to submit your work under the project license. See the full text at [https://developercertificate.org/](https://developercertificate.org/).
8+
9+
**All commits must be signed off.** Add a `Signed-off-by` line to your commit message, which is easiest via the `-s` flag:
10+
11+
```bash
12+
# one-time: set your real name and email (must match the sign-off)
13+
git config user.name "Your Real Name"
14+
git config user.email "you@example.com"
15+
16+
# sign off your commit
17+
git commit -s -m "feat: add Visual Groups Editor"
18+
```
19+
20+
This adds a footer like:
21+
22+
```
23+
Signed-off-by: Your Real Name <you@example.com>
24+
```
25+
26+
If you forgot to sign off:
27+
28+
```bash
29+
git commit --amend -s --no-edit
30+
# then push with force-if-safe
31+
git push --force-with-lease
32+
```
33+
34+
**Co-authors:** each contributor should add their own `Signed-off-by` line. You can still use `Co-authored-by:` lines as usual.
35+
36+
---
37+
38+
## Dev Setup
39+
40+
```bash
41+
npm ci
42+
npm run dev # Vite dev server; open demo/builder.html
43+
npm run build # outputs dist/*.es.js and dist/*.umd.cjs
44+
```
45+
46+
## Commit Style
47+
48+
Use **Conventional Commits**:
49+
50+
* `feat: …`, `fix: …`, `docs: …`, `chore: …`, `refactor: …`, etc.
51+
52+
## Pull Requests
53+
54+
1. Create a feature branch: `feat/your-topic`
55+
2. Include or update a demo under `demo/` when relevant
56+
3. Update README/CHANGELOG if behavior changes
57+
4. Ensure all commits are **signed off** (DCO)
58+
59+
## Coding Notes
60+
61+
* Renderer is framework‑agnostic; DOM only
62+
* Builder UI should rely on public formBuilder hooks (userAttrs, `onOpenFieldEdit`)
63+
* Keep rule matching **name‑based** (no CSS class coupling)
64+

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2025 Orlé
3+
Copyright (c) 2025 Jaimon Orlé
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

0 commit comments

Comments
 (0)