Contributing

A useful contribution can be a clearer guide, a small reproducible bug fix, or an example that explains a common graph task. Graphora is currently a development preview; working on the source requires repository access. See project status for the public-release plans.

Run the project

Use Node.js 22.13+ and pnpm 11.7.0. From a repository checkout:

cd graph-library
pnpm install --frozen-lockfile
pnpm site:build
pnpm exec vite preview --outDir dist/site --host 127.0.0.1

Open the printed URL to explore the complete site. Use pnpm docs:dev for shorter documentation editing cycles.

Choose a focused task

Start with a page that confused you, an example that behaves unexpectedly, or a problem you can reproduce with a small graph. Existing collaborators can use the repository's Issues tab and the bug report, documentation feedback, or feature request templates.

For a bigger feature, explain the user's task and the current limitation first. Maintainers can help narrow the scope. You do not need to read the research archive or design a new API to report a problem.

Make and verify a change

Use a branch or isolated worktree. Keep source changes under graph-library/ and public documentation under graph-library/docs/. Follow the repository's AGENTS.md when using an agent, and check the relevant spec before changing broad library behavior.

During development, run the checks relevant to your change. Before requesting merge, run the full gate:

pnpm release:check

It checks the packages, types, formatting, generated API reference and browser journeys. For a visible site change, inspect the result at desktop and mobile sizes. For a bug fix, add a regression test that would catch the failure.

Generated API pages come from the public package entrypoints and documentation comments. Update those sources, then run pnpm docs:api; do not hand-edit the reference HTML.

Request review

Explain what problem the change solves, how the result behaves, and what you checked. Link the issue and include a screenshot for a visible change. Mention any checks you could not run. Small PRs are easier to review and integrate while other people work on the library.

The root CONTRIBUTING.md contains the full repository workflow. Maintainers own scope, merges and releases; review timing is currently best-effort.

Report a problem

Include the example or page URL, exact reproduction steps, expected and actual behavior, checkout revision, browser and operating system. Use synthetic graph data and remove private information.

Repository collaborators can file ordinary bugs in Issues. A public support route will be documented when the project opens. For suspected vulnerabilities or exposed credentials, follow the repository's SECURITY.md and use the private maintainer channel rather than an ordinary issue.