Skip to content

Latest commit

 

History

History
48 lines (27 loc) · 1.09 KB

CONTRIBUTING.md

File metadata and controls

48 lines (27 loc) · 1.09 KB
Raw

Contribution

Please read Auth0's contribution guidelines.

Documentation

  • PR for docs site update, if needed
  • Code-level documentation expectations
    • 100% documentation coverage for PRs
    • Include links to relevant Auth0 doc pages

Assets compilation

Information about compiling CSS, JS, SVG, etc.

Environment setup

Link to README installation steps and include anything additional needed to contribute to the project.

Testing

Adding tests

General information about the test suite and how to format and structure tests.

Running tests

Any additional information needed to run the test suite. Include bash-formatted commands like:

composer test
bundle exec rake test

Also include any information about essential manual tests.

Code quality tools

Information about scripts to run before committing.

CI Information

What CI checks for and how to pass.

Repo-specific PR guidelines

Anything not covered in the general guidelines linked above.