Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
97 lines (69 loc) · 1.81 KB

CONTRIBUTING.md

File metadata and controls

97 lines (69 loc) · 1.81 KB
Raw

Contributing to CReact

Thank you for your interest in contributing to CReact! This document provides guidelines for contributing.

Getting Started

  1. Fork the repository
  2. Clone your fork: 
    git clone https://github.com/YOUR_USERNAME/creact.git
cd creact
  3. Install dependencies: 
    npm install
  4. Build the project: 
    npm run build
  5. Run tests: 
    npm test

Development Workflow

  1. Create a new branch for your feature or fix:

    git checkout -b feature/your-feature-name

  2. Make your changes

  3. Run tests to ensure everything works:

    npm test

  4. Commit your changes with a clear message:

    git commit -m "Add: description of your change"

  5. Push to your fork:

    git push origin feature/your-feature-name

  6. Open a Pull Request

Commit Messages

Use clear, descriptive commit messages:

  • Add: for new features
  • Fix: for bug fixes
  • Docs: for documentation changes
  • Refactor: for code refactoring
  • Test: for adding or updating tests

Code Style

  • Use TypeScript for all source files
  • Follow existing code patterns
  • Add tests for new functionality
  • Keep functions small and focused

Pull Request Guidelines

  1. Keep PRs focused on a single change
  2. Update documentation if needed
  3. Add tests for new features
  4. Ensure all tests pass
  5. Reference any related issues

Reporting Issues

When reporting issues, please include:

  • A clear description of the problem
  • Steps to reproduce
  • Expected vs actual behavior
  • Node.js version
  • Operating system

Questions?

Feel free to open an issue for questions or reach out to the maintainers.

License

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