Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
58 lines (39 loc) · 1.39 KB

CONTRIBUTING.md

File metadata and controls

58 lines (39 loc) · 1.39 KB
Raw

Contributing to Graph Lab

Thanks for your interest in contributing! This project is small enough that there's no formal process — just open something.

Types of Contributions

  • Bug fixes — if something's broken, open an issue with steps to reproduce
  • Features — discuss first in an issue for anything non-trivial
  • Docs — README improvements, examples, or code comments all count
  • Design — UI polish, accessibility, or new layout ideas

Getting Set Up

git clone https://github.com/gaurav7902/graph-visualizer.git
cd graph-visualizer
npm install
npm run dev

This project uses Prettier for formatting (.prettierrc is included). Run it before opening a PR:

npm run format

Making Changes

  1. Fork the repo and create a branch from master
  2. Keep PRs focused — one feature/fix per PR
  3. Describe what changed and why in the PR description
  4. Add a screenshot or GIF for anything visual

Code Style

  • TypeScript strict mode
  • Functional components with hooks
  • CSS custom properties for theming
  • Follow existing patterns in the codebase

Submitting a PR

  1. Ensure your code builds: npm run build
  2. Run formatting: npm run format
  3. Push your branch and open a PR against master
  4. Be patient — this is maintained outside of work hours

No contribution is too small. Thanks for even considering it!