Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
57 lines (44 loc) · 1.2 KB

CONTRIBUTING.md

File metadata and controls

57 lines (44 loc) · 1.2 KB

Contributing to react-terminal-typewriter

Thank you for your interest in contributing! This document provides guidelines and instructions for contributing.

Development Setup

  1. Fork and clone the repository
  2. Install dependencies: 
    npm install
  3. Start development mode: 
    npm run dev

Making Changes

  1. Create a new branch for your feature or fix: 
    git checkout -b feature/your-feature-name
  2. Make your changes
  3. Run tests: 
    npm test
  4. Build the project: 
    npm run build

Pull Request Process

  1. Update the README.md if needed
  2. Update the CHANGELOG.md with your changes
  3. Ensure all tests pass
  4. Create a Pull Request with a clear description

Code Style

  • Use TypeScript for all source files
  • Follow existing code formatting
  • Add JSDoc comments for public APIs
  • Keep the bundle size minimal

Reporting Issues

When reporting issues, please include:

  • A clear description of the problem
  • Steps to reproduce
  • Expected vs actual behavior
  • Your environment (React version, browser, etc.)

License

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