Skip to content

docs(community): improve contributor onboarding - #188

Open
flotob wants to merge 1 commit into
mainfrom
codex/community-onboarding
Open

docs(community): improve contributor onboarding#188
flotob wants to merge 1 commit into
mainfrom
codex/community-onboarding

Conversation

@flotob

@flotob flotob commented Aug 13, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • add contributor guidance covering issue scope, architecture, verification, MPL-2.0 licensing, and accountable AI assistance
  • replace the 776-line README with a concise project landing page and move detailed feature, protocol, configuration, development, and troubleshooting material under docs/
  • add structured bug and feature issue forms plus a lightweight pull request template
  • align local development, CI, and package engines on Node.js 24 LTS; repair the existing npm 11 lockfile gap for optional Electron Windows-signing packages
  • refresh the live repository description and homepage metadata

Impact

New contributors get one supported setup path, clear contribution expectations, structured reporting fields tailored to Freedom's protocols and node modes, and navigable documentation without losing the technical material previously embedded in the README.

Verification

  • npm ci on Node.js 24.18.1 / npm 11.16.0
  • npm run lint
  • npm test — 145 suites passed, 2,838 tests passed, 10 skipped
  • Prettier check for all changed Markdown, YAML, JSON, and workflow files
  • YAML parse validation for both issue forms, their chooser config, and CI
  • local-link validation for all changed Markdown files
  • git diff --check
  • staged secret-pattern scan

The repository-wide npm run format:check still reports pre-existing formatting drift and parser failures in untouched files, notably src/renderer/pages/settings.html and src/renderer/vendor/qrcode.min.js; every file changed here passes Prettier.

Closes #183
Closes #184
Closes #185

Add contribution guidance and structured GitHub templates, turn the README into a concise project landing page, and preserve detailed material under docs/. Align local development and CI on Node.js 24 LTS, repairing the existing lockfile for npm 11.
@flotob
flotob marked this pull request as ready for review August 14, 2026 15:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Suggestion: add .github/ISSUE_TEMPLATE Suggestion: slim down the README Suggestion: add CONTRIBUTING.md

1 participant