Skip to content

Latest commit

 

History

History
55 lines (41 loc) · 1.16 KB

CONTRIBUTING.md

File metadata and controls

55 lines (41 loc) · 1.16 KB

Contributing Guidelines

Code Style

  • Follow the established ESLint and Prettier configurations
  • Use TypeScript for all new code
  • Write meaningful commit messages
  • Add proper documentation for new features

Development Process

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Write/update tests
  5. Submit a pull request

Pull Request Process

  1. Update documentation if needed
  2. Add tests for new features
  3. Ensure all tests pass
  4. Update the README.md if needed
  5. Request review from maintainers

Commit Message Format

type(scope): subject

body

footer

Types:

  • feat: A new feature
  • fix: A bug fix
  • docs: Documentation only changes
  • style: Changes that do not affect the meaning of the code
  • refactor: A code change that neither fixes a bug nor adds a feature
  • perf: A code change that improves performance
  • test: Adding missing tests or correcting existing tests
  • chore: Changes to the build process or auxiliary tools

Code Review Process

  • All submissions require review
  • Reviewers should focus on:
    • Code quality
    • Test coverage
    • Documentation
    • Performance implications
    • Security considerations