0 Fork 0

mirror of https://github.com/Twigpine/node-explorer.git synced 2026-11-10 13:11:36 -10:00

Files

T

Kevin CodexandClaude Fable 5 d77cd9a846 Make repository open-source ready (#3 )

- Add Vitest unit test suite (60 tests) covering the pure-logic modules
  in src/lib/: fuzzy matcher, line-range permalinks, language detection,
  API helpers/classification, and TOC extraction
- Rewrite README with features, quick start, API docs, project structure,
  and testing guide
- Add MIT LICENSE, CONTRIBUTING.md, and a PR template
- Add GitHub Actions CI (lint, test, build)
- Rename package to gitlawb-node-explorer with proper metadata

Co-authored-by: Claude Fable 5 <[email protected]>

2026-07-03 07:36:52 +08:00

3.1 KiB

Raw Permalink Blame History

Contributing to gitlawb node explorer

Thanks for your interest in contributing! This document covers how to get set up, the conventions the codebase follows, and what to expect from the review process.

Getting started

Fork the repository and clone your fork.
Install dependencies and start the dev server:
```
npm install
npm run dev
```
Requires Node.js 20+. The dev server proxies API calls to https://node.gitlawb.com — no backend setup needed.
Create a branch off main for your change:
```
git checkout -b feat/short-description
```

Before you open a PR

Run the full check suite locally — CI runs the same three commands:

npm run lint
npm test
npm run build

All three must pass. npm run build includes the TypeScript project build (tsc -b), so type errors fail there.

What makes a good PR

Keep it focused. One logical change per PR. Refactors, formatting sweeps, and behavior changes belong in separate PRs.
Add tests for logic. New pure functions in src/lib/ should ship with a colocated *.test.ts file. Bug fixes should include a test that fails without the fix.
Match the surrounding style. The codebase favors small framework-free modules in src/lib/, hooks in src/hooks/, and presentational components that receive data via props. Comments explain why, not what.
Mind the bundle. marked and shiki are lazy-loaded on purpose — don't import them (directly or transitively) from modules used by the page entry. src/lib/lang.ts exists specifically to keep detection separate from rendering.
Screenshots for UI changes. The PR template asks for before/after screenshots of any visual change, in both dark and light themes if the change touches themed surfaces.

Testing guidelines

Tests run on Vitest; the default environment is node.
If a test needs the DOM, add // @vitest-environment jsdom as the first line of the file rather than switching the global environment.
Stub the network with vi.stubGlobal('fetch', …) — tests must not hit a real node.
Time-dependent code (e.g. timeAgo) should be tested with vi.useFakeTimers() + vi.setSystemTime(…).

Commit messages

Use concise, imperative subject lines (Add line-range permalinks to file viewer). Conventional-commit prefixes (feat:, fix:, docs:, test:, chore:) are welcome but not required.

Reporting bugs and proposing features

Open a GitHub issue with:

what you expected vs. what happened,
steps to reproduce (including the node you were pointed at, if not the default),
browser and OS for rendering issues.

For larger features, please open an issue to discuss the approach before investing in an implementation — it saves everyone time if the direction is agreed on first.

Code of conduct

Be kind and constructive. By participating you agree to uphold the Contributor Covenant.

License

By contributing, you agree that your contributions will be licensed under the MIT License.

3.1 KiB Raw Permalink Blame History