Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
30 lines (23 loc) · 1.43 KB

CONTRIBUTING.md

File metadata and controls

30 lines (23 loc) · 1.43 KB

Contributing

Contributions are always welcome, but to keep things organized, keep in mind the following rules.

⚡ Important Note:
String Morpher is dedicated exclusively to string transformation and manipulation. Comparison and validation methods (like startsWith, contains, endsWith, similarity, isValidEmail, isValidCpf, etc) are not provided and outside the project's scope.

Bug Reports

When reporting a bug in the package, make sure you follow the rules:

  • You have read the Installation and General Configuration sections of the documentation;
  • The issue you're facing is not documented;
  • A GitHub issue with the problem you're having doesn't already exist (in an open or closed state);

Failure to do so, will result in a closed ticket.

Pull Requests

Fixing a bug, correcting a typo or adding a new feature?

  • Add or fix the morpher logic in src/Transformers/
    • Implement the StringTransformerInterface.
    • Follow the main method pattern: transform(string $input, mixed ...$args): string.
  • Update the Facade:
    • Add or edit a PHPDoc @method in:
      • src/StringMorpher.php
      • src/Instances/StringMorpherInstance.php
    • Follow the pattern for IDE autocompletion.
  • Add or edit a section in docs/docs/methods/ explaining the method.
  • Add or edit a test in tests/Transformers/.

Just remember that all pull requests should be done against the main branch.