Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
44 lines (27 loc) · 1.21 KB

CONTRIBUTING.md

File metadata and controls

44 lines (27 loc) · 1.21 KB

Contributing to Metrics

Metrics is an open-source project and we welcome contributions. Whether you're fixing a bug, improving the documentation, or adding a new feature, we appreciate your help.

Getting Started

To get started, fork the repository and clone it to your local machine. You can find the repository at https://github.com/dshafik/metrics.

git clone https://github.com/dshafik/metrics.git

Installation

To install the project dependencies, run the following command:

composer install

This will install the required dependencies for the project, and install the git hooks.

Running Tests

To run the test suite, use the following command:

composer run test

Coding Standards

Metrics follows the Laravel Coding Style standard. Laravel Pint is used to enforce code style. To check your code for style violations, run the following command:

composer run style

Commit Standards

All commits must adhere to the Conventional Commits specification.

Tip

Pre-commit hooks will automatically run tests, style checks, linting, and validate commit messages.