Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
35 lines (28 loc) · 1.59 KB

CONTRIBUTING.md

File metadata and controls

35 lines (28 loc) · 1.59 KB

Contributing

Thank you for the interest in Url highlight library. If you find a problem or want to discuss new features you are welcome to open an issue and/or a pull request.

When submitting your pull request, consider writing a description which explains the changes. Please note that not all pull requests may be merged. Merging a PR is at the discretion of the maintainer and depends on factors such as: relevance to the project's goals, impact on maintainability and code quality.

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

Workflow

  1. Fork the repository.
  2. Start your branch from main.
  3. Implement your change and add tests for it.
  4. Follow the contributing rules.
  5. Ensure the tests passes. See tests and tools for details.
  6. Publish pull request and wait for review.

Rules

Here are a few rules to follow when making changes to this project:

  • Follow PSR-12 code style.
  • Take care of complete code coverage with tests.
  • Keep documentation up to date with new features and changes.
  • Be consistent with existing code in the project.
  • Code should properly run on supported PHP versions (see composer.json require section).

Tests and tools

To run all the tests and checks use composer test:all script:

composer test:all

For other tools, see scripts section of composer.json.