Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
55 lines (37 loc) · 1.56 KB

CONTRIBUTING.md

File metadata and controls

55 lines (37 loc) · 1.56 KB
Raw

Contributing to SadPath

Thanks for your interest in contributing! SadPath is built for developers who don't trust happy paths — and that includes our contributors.

Getting Started

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/YOUR_USERNAME/SadPath.git
  3. Install dependencies: npm install
  4. Start the dev server: npm run dev
  5. Create a branch: git checkout -b feature/your-feature

Development Guidelines

Code Style

  • Use TypeScript for all new code
  • Follow existing component patterns and naming conventions
  • Use Tailwind CSS for styling — avoid inline styles
  • Keep components focused and composable

ChaosEngine Tests

When adding new test modules:

  1. Extend BaseTest in src/engine/tests/
  2. Implement the run(url, isDemo) method
  3. Return normalized ChaosIssue[] results
  4. Register the test in ChaosEngine.ts
  5. Add demo data in src/data/demoData.ts

Commit Messages

Use clear, descriptive commit messages:

feat: add color contrast accessibility test
fix: prevent horizontal scroll on mobile results page
docs: update deployment instructions

Pull Request Process

  1. Ensure your code builds: npm run build
  2. Test demo mode works end-to-end
  3. Update README if adding new features
  4. Submit PR with a clear description of changes

Security

If you discover a security vulnerability (especially SSRF-related), please do not open a public issue. Email the maintainer directly.

Code of Conduct

Be respectful, constructive, and remember: we're all trying to break things productively.