Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
80 lines (56 loc) · 1.77 KB

CONTRIBUTING.md

File metadata and controls

80 lines (56 loc) · 1.77 KB
Raw

Contributing to ContextCypher

Prerequisites

  • Node.js v18+ (nvm-windows on Windows, nvm on macOS/Linux)
  • npm v10+
  • Git
  • Ollama (optional) -- for local AI features. ollama.com

Setup

git clone https://github.com/Threat-Vector-Security/contextcypher.git
cd contextcypher
npm install
cd server && npm install && cd ..

Building and Running

The simplest way to build and run the full application:

# Windows
.\full-rebuild.ps1

# Linux / macOS
./full-rebuild.sh

This installs dependencies, builds the frontend and backend, and starts both servers. If this runs successfully, your environment is working.

For frontend-only work with hot reload:

# Windows
.\Development-Rebuild.ps1

# Linux / macOS
./Development-Rebuild.sh

Or run manually on any platform:

# Backend
cd server && npm run dev

# Frontend (separate terminal)
npm start

Submitting Changes

  1. Fork the repo and create a feature branch from main
  2. Make your changes
  3. Verify the app builds and runs (.\full-rebuild.ps1 on Windows, ./full-rebuild.sh on Linux/macOS)
  4. Commit with a clear message describing what changed
  5. Open a Pull Request against main

Code Style

  • TypeScript for frontend code
  • Material-UI for UI components
  • ReactFlow for diagram rendering
  • Follow existing patterns in the codebase
  • Keep files under 500 lines when practical

Reporting Issues

Open a GitHub Issue with:

  • Steps to reproduce
  • Expected vs actual behavior
  • OS, Node.js version, and AI provider in use
  • Screenshots if it's a UI issue

Thanks for contributing.