docs: add CONTRIBUTING.md (#422)#425
Merged
Merged
Conversation
…#422) JSS had no `CONTRIBUTING.md` at the repo root. New contributors — human and agent — had to reverse-engineer the project's conventions from commit history. This adds a one-screen reference card surfacing what's already de-facto practice, plus formal stances on AI-assisted contributions and forks. Sections: - Quick start: clone / install / test / run - Workflow: issue → branch → PR → merge → pull (no direct commits to the default branch) - Code style: ESM, Node ≥ 22 LTS, no native modules, JSDoc, node --test, no build step - AI-assistance disclosure: three-tier disclosure (hand-authored / AI-assisted with review / substantially AI-generated), prompt sharing for substantial AI-generated portions, authorship responsibility stays with the contributor, per-contributor flexibility for established history. Aligns with NLnet's generative-AI policy for funded projects. - Forks and downstream distribution: AGPL-3.0 § 5(a) modification notice obligation on conveyed modified versions; happy to advise on application. - Licence and CLA: AGPL-3.0 default; CLA in progress, required for substantial contributions ahead of 0.1. - Where to ask: GitHub issue tracker is canonical; security issues via forthcoming SECURITY.md. References: - NLnet generative-AI policy: https://nlnet.nl/foundation/policies/generativeAI/ - AGPL-3.0 § 5(a): https://www.gnu.org/licenses/agpl-3.0.en.html#section5
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #422.
Adds a one-screen
CONTRIBUTING.mdat repo root covering the project's de-facto conventions plus formal stances on AI-assisted contributions and forks.Sections
issue → branch → PR → merge → pull, no direct commits to the default branchnode --test, no build step0.1. Until then, commit-via-PR constitutes acceptance.SECURITY.md.Follow-ups (not in this PR)
.github/pull_request_template.mdcarrying the AI-disclosure checklist inline (referenced in CONTRIBUTING)SECURITY.mdfor responsible-disclosure pathMAINTAINERS.mdonce second-maintainer onboarding completes.githubrepo with universal portions (AI-disclosure + fork policy) inherited acrossJavaScriptSolidServer/*repos0.1Why now
This is the 0.1-prep contributing-guide work referenced in the roadmap discussion. Universal policy framing — applies to all contributors including the maintainer.