Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
49 lines (36 loc) · 1.02 KB

CONTRIBUTING.md

File metadata and controls

49 lines (36 loc) · 1.02 KB

Contributing to graphql-agent-toolkit

Thank you for your interest in contributing!

Development Setup

git clone https://github.com/mstuart/graphql-agent-toolkit.git
cd graphql-agent-toolkit
npm install

Development Workflow

npm run build    # Build ESM + CJS output
npm test         # Run tests with Vitest
npm run lint     # Run ESLint

Making Changes

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/my-feature)
  3. Make your changes
  4. Add tests for new functionality
  5. Ensure all tests pass (npm test)
  6. Ensure lint passes (npm run lint)
  7. Commit your changes with a descriptive message
  8. Push to your fork and open a Pull Request

Code Style

  • TypeScript strict mode
  • ESLint + Prettier for formatting
  • Prefer small, focused functions
  • Add tests for all new functionality

Reporting Bugs

Please open an issue with:

  • Steps to reproduce
  • Expected behavior
  • Actual behavior
  • Node.js version and OS

Questions?

Open a discussion or issue on GitHub.