You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Repair and validate documentation links, add a current bilingual project story and roadmap, define governance and community standards, publish an unreleased changelog, and automate ownership, dependency updates, and Gallery submissions.
Notable user-visible changes are recorded here. ScriptWidget follows semantic versioning for public package/runtime contracts even when App Store marketing versions use another cadence.
4
+
5
+
## Unreleased
6
+
7
+
### Added
8
+
9
+
- Full macOS app and WidgetKit workspace with Studio editing, diagnostics, Console, multi-size previews, native commands, and first-run tutorial.
10
+
- OpenAI-compatible Widget generation with Keychain-backed credentials, structured prompts, run/diagnose/refine workflow, evaluations, and reusable Skills 1.0.
- Expanded the template catalog to 70 validated examples and generated preview fixtures.
18
+
- Reworked documentation around a five-minute path, versioned Runtime API, Studio, AI, Skills, packages, Gallery, release readiness, and bilingual onboarding.
19
+
20
+
### Fixed
21
+
22
+
- Added local build-cache fallback and proactive package caching for scripts evicted by iCloud. GitHub issue #6 remains open until the physical-iPhone offline acceptance matrix is complete.
ScriptWidget is built by people with different backgrounds and levels of experience. We are committed to a welcoming, safe, and constructive community.
4
+
5
+
## Expected behavior
6
+
7
+
- Be respectful, patient, and specific. Critique ideas and code, not people.
8
+
- Welcome beginners and explain assumptions without gatekeeping.
9
+
- Respect privacy, licenses, authorship, and responsible security disclosure.
10
+
- Accept feedback, correct mistakes, and prioritize the health of the community.
11
+
- Keep discussions relevant and avoid harassment, threats, discrimination, sexualized attention, spam, or publishing another person's private information.
12
+
13
+
## Enforcement
14
+
15
+
Maintainers may edit or remove content, close participation, or temporarily or permanently ban contributors whose behavior harms the community. Enforcement should be proportional, documented privately when practical, and avoid exposing reporters or affected people.
16
+
17
+
Report conduct concerns privately to `xnuapp@gmail.com`. Do not use a public issue for sensitive reports. Maintainers will review the available context, protect confidentiality as far as practical, and communicate the outcome to affected parties when appropriate.
18
+
19
+
This policy applies in repository spaces and when someone publicly represents the ScriptWidget project.
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,8 @@
2
2
3
3
Thank you for helping make native widget creation accessible to everyone. Contributions to the runtime, ScriptWidget Studio, templates, tests, and documentation are welcome.
4
4
5
+
Participation is governed by the [Code of Conduct](CODE_OF_CONDUCT.md). Maintainer roles and project decisions are described in [Governance](GOVERNANCE.md), current priorities in the [Roadmap](ROADMAP.md), and notable user-visible work in the [Changelog](CHANGELOG.md).
6
+
5
7
## Before you start
6
8
7
9
- Search existing issues and discussions before opening a duplicate.
ScriptWidget uses a maintainer-led, contribution-friendly model. The goal is to make decisions transparent while keeping a security-sensitive Apple application coherent and shippable.
4
+
5
+
## Roles
6
+
7
+
-**Users** report needs, test releases, and share widgets or Skills.
8
+
-**Contributors** submit code, tests, documentation, designs, templates, or reviews under the project license.
9
+
-**Reviewers** are trusted contributors who consistently provide accurate review in a subsystem.
10
+
-**Maintainers** merge changes, manage releases and security reports, curate Gallery content, and set repository policy. The current lead maintainer is Everett Jiang (`@everettjf`).
11
+
12
+
Roles are earned through sustained, constructive work. Maintainers may delegate review areas and should document new maintainer or reviewer responsibilities publicly.
13
+
14
+
## Decisions
15
+
16
+
Routine fixes use pull-request review and passing release checks. Significant changes—public Runtime APIs, package formats, security boundaries, data collection, platform scope, large dependencies, or migrations—start with an issue or discussion describing the user problem, alternatives, compatibility, risk, tests, and documentation.
17
+
18
+
Maintainers seek rough consensus, but the lead maintainer has final responsibility when a decision is blocked. Decisions should cite technical and user evidence; disagreement is not misconduct. Security fixes may be developed privately and documented after coordinated disclosure.
19
+
20
+
## Compatibility and trust
21
+
22
+
Runtime and package contracts are versioned. Breaking changes require an explicit migration path and release note. Imported scripts, network content, Gallery metadata, AI output, iCloud documents, app-group storage, and credentials are security boundaries and must fail closed.
23
+
24
+
The Gallery is curated, not an unrestricted executable marketplace. Inclusion is discretionary and may be revoked for security, privacy, licensing, abandonment, misleading behavior, or repeated quality failures.
25
+
26
+
## Releases
27
+
28
+
A release candidate should pass `./Scripts/release-readiness.sh`, document known limitations, and complete the device matrix appropriate to its changes. Maintainers publish release notes from `CHANGELOG.md` and may defer a feature that cannot be verified safely.
29
+
30
+
## Policy changes
31
+
32
+
Governance changes use a pull request and normal public review. The lead maintainer may make an urgent temporary policy change for safety, followed by a documented review.
See the [public roadmap](ROADMAP.md), [governance model](GOVERNANCE.md), and [Gallery submission guide](docs/gallery.md). Every pull request runs the same release-readiness checks used locally.
0 commit comments