Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
86 lines (60 loc) · 2 KB

CONTRIBUTING.md

File metadata and controls

86 lines (60 loc) · 2 KB
Raw

Contributing

Thank you for your interest in contributing to this project!

How to Contribute

Reporting Bugs

  1. Check existing issues to avoid duplicates
  2. Use the bug report template if available
  3. Include:
    • Clear description
    • Steps to reproduce
    • Expected vs actual behavior
    • Environment details (OS, browser, version)

Suggesting Features

  1. Open an issue with the enhancement label
  2. Describe the use case and benefits
  3. Provide examples if possible

Pull Requests

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/amazing-feature
  3. Make your changes
  4. Test thoroughly
  5. Commit with clear messages: git commit -m 'Add amazing feature'
  6. Push to your fork: git push origin feature/amazing-feature
  7. Open a Pull Request

Code Style

  • Follow existing code style and conventions
  • Use descriptive variable names
  • Add comments for complex logic
  • Keep functions focused and small
  • Write tests for new functionality

Commit Messages

Use conventional commits:

  • feat: New feature
  • fix: Bug fix
  • docs: Documentation changes
  • style: Code style (formatting, semicolons, etc)
  • refactor: Code refactoring
  • test: Adding or updating tests
  • chore: Maintenance tasks

Example: feat: add user authentication

Testing

  • Run existing tests before submitting
  • Add tests for new functionality
  • Ensure all tests pass
  • Include both unit and integration tests where applicable

Documentation

  • Update README.md if needed
  • Add inline code comments
  • Update API documentation
  • Include examples for new features

Code Review Process

  1. At least one maintainer will review your PR
  2. Changes may be requested
  3. All CI checks must pass
  4. Maintainer will merge after approval

Development Setup

See the README.md for setup instructions specific to this project.

Questions?

Open an issue or contact the maintainers.

License

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