Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
47 lines (38 loc) · 2.56 KB

CONTRIBUTING.md

File metadata and controls

47 lines (38 loc) · 2.56 KB
Raw

Contributing to the Website

Thanks for contributing to the xfetch website. This repository contains the Next.js site (src/) and the rendered documentation (docs/) in three languages: English (en), Spanish (es) and German (de).

Workflow

  1. Fork the repository and create a feature branch.
  2. Make your change in src/ (site code) and/or docs/<lang>/ (documentation).
  3. Run the CI locally before opening the PR: bash scripts/ci.sh (Linux/macOS) or ./scripts/ci.ps1 (Windows). It runs npm run lint and npm run build. PRs that fail CI are rejected.
  4. Open a pull request.

Documentation Rules

  • Three languages. Every documentation page exists in en, es and de. A change to one language must be mirrored in the other two — pages missing in a language are not rendered.
  • Source of truth is the repos. The docs describe the other xfetch repositories (xfetch, plugins, extensions, themes, configs). Verify config keys, commands and behaviors against the code before documenting them; keep the pages as adaptations, not verbatim copies.
  • Keep the markdown structure of the page (title, sections, tables) so titles, descriptions and the summary stay consistent.
  • No emojis in documentation; use Nerd Font glyphs or plain text where icons are needed.
  • Update docs/<lang>/SUMMARY.md when adding or removing pages.

Site Code Rules

  • Run npm run lint before committing; fix warnings, do not disable rules without a comment explaining why.
  • Keep the docs renderer (src/app/docs/, src/lib/docs.ts) dependency-light: markdown is rendered with react-markdown + remark-gfm.
  • No unused imports or dead props — the docs pages are statically generated, keep them deterministic.

Code of Conduct

Be respectful, constructive, and collaborative. Harassment, trolling, and personal attacks are not tolerated.