Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
50 lines (36 loc) · 1.28 KB

CONTRIBUTING.md

File metadata and controls

50 lines (36 loc) · 1.28 KB

Contributing to SNL Typed.js

Thank you for considering contributing to this package!

How to Contribute

Reporting Bugs

If you discover a bug, please create an issue on GitHub with:

  • A clear, descriptive title
  • Steps to reproduce the issue
  • Expected behavior
  • Actual behavior
  • Your environment (PHP version, Laravel version, etc.)

Suggesting Enhancements

Enhancement suggestions are welcome! Please provide:

  • A clear description of the enhancement
  • Why this enhancement would be useful
  • Examples of how it would work

Pull Requests

  1. Fork the repository
  2. Create a new branch for your feature (git checkout -b feature/amazing-feature)
  3. Make your changes
  4. Ensure code follows PSR-12 coding standards
  5. Add tests if applicable
  6. Commit your changes (git commit -m 'Add amazing feature')
  7. Push to the branch (git push origin feature/amazing-feature)
  8. Open a Pull Request

Coding Standards

  • Follow PSR-12 coding standards
  • Add PHPDoc comments for all public methods
  • Keep backwards compatibility in mind
  • Write clear, self-documenting code

Testing

Before submitting a pull request, ensure:

  • All existing tests pass
  • New features include tests
  • Code is properly formatted

Questions?

Feel free to open an issue for any questions or clarifications.