Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
57 lines (39 loc) · 1.04 KB

CONTRIBUTING.md

File metadata and controls

57 lines (39 loc) · 1.04 KB

Contributing to coloralgorithm

Thank you for your interest in contributing to coloralgorithm!

Getting Started

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/YOUR_USERNAME/coloralgorithm.git
  3. Install dependencies: npm install
  4. Create a branch for your changes: git checkout -b my-feature

Development

Building

npm run build    # One-time build
npm run start    # Watch mode for development

Testing

npm test

Linting

npm run lint

Pull Request Guidelines

  1. Make sure all tests pass
  2. Update documentation if needed
  3. Keep changes focused and atomic
  4. Write clear commit messages

Reporting Issues

When reporting issues, please include:

  • Node.js version
  • npm version
  • Operating system
  • Steps to reproduce
  • Expected vs actual behavior

Code Style

  • Use TypeScript
  • Use const over let when possible
  • Follow existing code patterns

License

By contributing, you agree that your contributions will be licensed under the Apache 2.0 License.