Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
55 lines (40 loc) · 1.27 KB

CONTRIBUTING.md

File metadata and controls

55 lines (40 loc) · 1.27 KB

Contributing to rect-utils

Thank you for your interest in contributing to rect-utils!

How to Contribute

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Make your changes
  4. Build and test your changes (npm run build)
  5. Commit your changes (git commit -m 'Add some amazing feature')
  6. Push to the branch (git push origin feature/amazing-feature)
  7. Open a Pull Request

Development Setup

# Clone your fork
git clone https://github.com/YOUR_USERNAME/rect-utils.git
cd rect-utils

# Install dependencies
npm install

# Build the project
npm run build

Code Style

  • Use TypeScript
  • Follow functional programming style
  • Add JSDoc comments for public APIs
  • Keep functions pure when possible
  • Use meaningful variable names

Reporting Bugs

Please use the GitHub issue tracker to report bugs. Include:

  • A clear description of the issue
  • Steps to reproduce
  • Expected behavior
  • Actual behavior
  • Code samples if applicable

Feature Requests

Feature requests are welcome! Please open an issue describing:

  • The problem you're trying to solve
  • Your proposed solution
  • Any alternatives you've considered

License

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