Skip to content

Latest commit

 

History

History
42 lines (26 loc) · 1.86 KB

CONTRIBUTING.md

File metadata and controls

42 lines (26 loc) · 1.86 KB
Raw

Contributing

We provide and maintain SDKs for the benefit of our developer community. Feedback, detailed bug reports, and focused PRs are always appreciated. Thank you in advance!

When contributing to this SDK, please:

  • Maintain the minimum PHP version (found under require.php in composer.json for the branch).
  • Code to the PSR-2 standard.
  • Run composer pre-commit for the whole project before submitting your PR for review. You can add this to a pre-commit hook with the following:
echo '#!/bin/sh' > .git/hooks/pre-commit && echo 'composer pre-commit' >> .git/hooks/pre-commit
  • Run composer phpcs for the changed PHP files before submitting your PR for review (optional).
  • Keep PRs focused and change the minimum number of lines to achieve your goal.

Running unit tests

Prior to making a PR, ensure that the unit tests pass:

composer test-unit

Running integration tests

The integration tests require a tenant and Auth0 Application configured with the following:

  • The Application must be of type Machine-to-Machine and have the Management API authorized
  • The tenant must have the default Database connection named "Username-Password-Authentication", and it must not have the "Requires Username" enabled
  • The tenant must have at least two rules (they can be empty rules)

You will also need to create a .env file in the root of this package with the following entries:

  • DOMAIN - Auth0 domain for your test tenant
  • APP_CLIENT_ID - Client ID for a Machine-to-Machine Application within your test tenant
  • APP_CLIENT_SECRET - Client Secret for a Machine-to-Machine Application within your test tenant

This file is automatically excluded from Git with the .gitignore for this repo.

To run the integration tests:

composer test-integration