CONTRIBUTING.md

Contributing to class-name-extractor

Thank you for your interest in contributing! This document outlines the process for contributing to this project.

Requirements tools

• Node.js 20.14.0
• pnpm 9.12.3

Development Setup

1. Fork and clone the repository

   git clone https://github.com/yourusername/project-name.git
   cd project-name

2. Install dependencies

   pnpm install

3. Run build purescript files

   pnpm run build

Pull Request Process

1. Create a new branch

   git checkout -b feature/your-feature-name

2. Make your changes and commit

   git commit -m "Add new feature"

3. Push to your fork and submit a pull request

   git push origin feature/your-feature-name

4. Ensure your PR description clearly describes the changes and links to relevant issues

Code Style

• Follow the existing code style
• Use meaningful variable and function names
• Add comments for complex logic
• Write unit tests for new features
• Provide detailed commit messages to explain why the changes were made.

Report Issues

• Use the issue tracker for bugs and feature requests
• Search existing issues before creating a new one
• Provide detailed reproduction steps for bugs

Code of Conduct

This project follows our Code of Conduct. Please read it before contributing.

Questions?

Feel free to open an issue or contact the maintainers.

Thank you for contributing!