Skip to content

Commit 3257be6

Browse files
melvincarvalhomelvincarvalho
committed
Initial community-health files and org landing
Adds the org-wide defaults for the JavaScriptSolidServer organization: - README.md — org landing page (visible at github.com/JavaScriptSolidServer): featured projects, standards-alignment summary, contributing pointer - CONTRIBUTING.md — universal portions (workflow, AI-assistance disclosure, fork policy, CLA placeholder, where-to-ask). Per-repo CONTRIBUTING files (e.g. main JSS server) extend with project- specific Quick start and Code style sections - PULL_REQUEST_TEMPLATE.md — AI-disclosure checklist, summary, linked issue, test plan - ISSUE_TEMPLATE/bug_report.md and feature_request.md — quality-gated intake AI-assistance disclosure aligns with NLnet's generative-AI policy for funded projects (https://nlnet.nl/foundation/policies/generativeAI/). Forks-and-downstream-distribution section sets the AGPL-3.0 §5(a) modification-notice expectation org-wide; *"happy to advise"* closer for any contributor unsure how to apply the notice cleanly.
1 parent fbc007e commit 3257be6

5 files changed

Lines changed: 209 additions & 0 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
# Contributing to JavaScriptSolidServer projects
2+
3+
This is the organization-wide default. Individual repositories may
4+
publish their own `CONTRIBUTING.md` with project-specific Quick start
5+
and Code style sections (e.g. the JSS server repo); when they do, that
6+
overrides this one. The sections below apply universally.
7+
8+
## Workflow
9+
10+
Projects follow a strict **issue → branch → PR → merge → pull**
11+
sequence. No direct commits to the default branch.
12+
13+
1. Open an issue describing the change (or pick an existing one)
14+
2. Branch: `git checkout -b issue-<number>-short-slug`
15+
3. Commit with a descriptive title + multi-paragraph body explaining
16+
the *why*
17+
4. Open a PR linked to the issue
18+
5. Address Copilot review iteratively until clean (the org leans
19+
heavily on automated review passes)
20+
6. Squash-merge, delete branch, `git pull`
21+
22+
## AI-assistance disclosure
23+
24+
We welcome thoughtfully-prepared contributions, including those drafted
25+
with AI assistance. To keep provenance clear:
26+
27+
- **Disclose AI assistance** in the PR description. Indicate one of:
28+
- hand-authored
29+
- AI-assisted with substantive human review
30+
- substantially AI-generated
31+
- **Share prompts** for substantial AI-generated portions (in the PR
32+
description or a linked artifact) so reviewers can assess scope.
33+
- **Authorship responsibility** — code review, follow-up, and licence
34+
obligations stay with the contributor regardless of AI involvement.
35+
- **Per-contributor flexibility** — established contributors with a
36+
consistent disclosure history may agree streamlined arrangements
37+
with the maintainer.
38+
39+
This is consistent with [NLnet's generative-AI policy for funded
40+
projects](https://nlnet.nl/foundation/policies/generativeAI/) and
41+
general open-source provenance best practice.
42+
43+
A pull-request template (`.github/pull_request_template.md`) carries
44+
the same checklist so every PR captures the disclosure inline.
45+
46+
## Forks and downstream distribution
47+
48+
Projects in this org are AGPL-3.0. Forks are welcome.
49+
50+
The licence terms set the boundary: **§5(a)** requires a prominent
51+
modification notice on conveyed (deployed, published, or distributed)
52+
modified versions, with a relevant date. Forks operating a public
53+
deployment are encouraged to surface this notice on the deployment
54+
itself — about page, footer, response headers, or equivalent — so
55+
downstream users have visible provenance.
56+
57+
If you are forking and want to ensure §5(a) compliance, please open
58+
an issue or ping the maintainer; happy to advise on how to apply the
59+
notice cleanly.
60+
61+
## Licence and CLA
62+
63+
All projects in this org are licensed under AGPL-3.0 (see each
64+
repository's `LICENSE`). Contributions are accepted under the same
65+
licence by default.
66+
67+
A Contributor Licence Agreement is being drafted and will be required
68+
for substantial contributions ahead of the relevant repository's `0.1`
69+
release; details and process will be published as part of that
70+
milestone work. Until then, the GitHub commit-via-PR flow constitutes
71+
acceptance of the project licence for the contributed change.
72+
73+
## Where to ask
74+
75+
- **Bugs / feature requests:** the relevant repository's GitHub issue
76+
tracker
77+
- **Security issues:** see the repository's `SECURITY.md` (where
78+
present) for the responsible-disclosure path
79+
- **General questions:** the relevant repository's issue tracker;
80+
conversational venues are intentionally not listed here so the
81+
canonical record stays on GitHub

‎ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
name: Bug report
3+
about: Report a defect you can reproduce
4+
title: ''
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
## What happened
10+
11+
<!-- One or two sentences. -->
12+
13+
## What was expected
14+
15+
<!-- The behaviour you expected. -->
16+
17+
## Steps to reproduce
18+
19+
1.
20+
2.
21+
3.
22+
23+
## Environment
24+
25+
- Repository / version:
26+
- Node version (if relevant):
27+
- OS / browser (if relevant):
28+
29+
## Additional context
30+
31+
<!-- Logs, screenshots, links to related issues, anything else useful. -->

‎ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: Feature request
3+
about: Propose a new capability or enhancement
4+
title: ''
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
## What problem does this solve
10+
11+
<!-- The use case or pain point you're addressing. -->
12+
13+
## Proposed approach
14+
15+
<!-- How you'd see this working. Sketches, references, or rough APIs welcome. -->
16+
17+
## Alternatives considered
18+
19+
<!-- Other approaches you weighed and why you chose this one (optional). -->
20+
21+
## Additional context
22+
23+
<!-- Related issues, prior art in other projects, anything useful. -->

‎PULL_REQUEST_TEMPLATE.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
<!--
2+
Thanks for your contribution. Please fill in the sections below.
3+
See CONTRIBUTING.md in this repository (or the org-default
4+
https://github.com/JavaScriptSolidServer/.github) for full details.
5+
-->
6+
7+
## Summary
8+
9+
<!-- One or two sentences describing what changed and why. -->
10+
11+
## Linked issue
12+
13+
<!-- e.g. Closes #123 -->
14+
15+
## AI-assistance disclosure (required)
16+
17+
Indicate one:
18+
19+
- [ ] Hand-authored
20+
- [ ] AI-assisted with substantive human review
21+
- [ ] Substantially AI-generated
22+
23+
If substantially AI-generated, please share the prompts (here or in a
24+
linked artifact) so reviewers can assess scope.
25+
26+
I have reviewed this change, take authorship responsibility, and agree
27+
to address review feedback.
28+
29+
## Test plan
30+
31+
<!-- How was this verified? Existing tests, new tests, manual repro. -->

‎README.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# JavaScript Solid Server (JSS) Org
2+
3+
The agentic-native, Nostr-aligned, standards-track home for Solid pod
4+
infrastructure and tooling.
5+
6+
## Featured projects
7+
8+
- **[JSS][jss]** — A minimal, fast, JSON-LD-native Solid server. ESM,
9+
no native modules, runs on Termux, postmarketOS, and Cloudflare
10+
Workers.
11+
- **[jss-git][jss-git]** — Web-based git browser for Solid pods (Preact
12+
+ isomorphic-git, no build step).
13+
- **[podkey][podkey]** — Nostr-key browser extension for NIP-98
14+
authentication against Solid pods.
15+
- **[jss-android][jss-android]** — Native Android pod (work in
16+
progress).
17+
- **[git-credential-nostr][gcn]** — Git helper for Nostr-signed
18+
commits.
19+
- **[nostr-git-sync][ngs]** — Sync git repositories over Nostr relays.
20+
21+
## Standards alignment
22+
23+
- W3C [CID v1.0][cid] — Recommendation. Implemented in JSS pod
24+
profiles.
25+
- `did:nostr` — Registered DID method. Native resolution in JSS.
26+
- W3C [LWS][lws] (Linked Web Storage) — FPWD; JSS implements
27+
ahead of REC.
28+
- AGPL-3.0 across all projects.
29+
30+
## Get involved
31+
32+
See [CONTRIBUTING][contrib] for workflow, code style, AI-assistance
33+
disclosure, and fork-policy expectations.
34+
35+
[jss]: https://github.com/JavaScriptSolidServer/JavaScriptSolidServer
36+
[jss-git]: https://github.com/JavaScriptSolidServer/git
37+
[podkey]: https://github.com/JavaScriptSolidServer/podkey
38+
[jss-android]: https://github.com/JavaScriptSolidServer/jss-android
39+
[gcn]: https://github.com/JavaScriptSolidServer/git-credential-nostr
40+
[ngs]: https://github.com/JavaScriptSolidServer/nostr-git-sync
41+
[cid]: https://www.w3.org/TR/cid-1.0/
42+
[lws]: https://www.w3.org/TR/2026/WD-lws10-authn-ssi-cid-20260423/
43+
[contrib]: ./CONTRIBUTING.md

0 commit comments

Comments
 (0)