Skip to content

Latest commit

 

History

History
54 lines (33 loc) · 1.65 KB

CONTRIBUTING.md

File metadata and controls

54 lines (33 loc) · 1.65 KB
Raw

Contributing to setup-php

Contributor Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Workflow

  • Fork the project.
  • Make your bug fix or feature addition.
  • Add tests for it. This is important so we don't break it in a future version unintentionally.
  • Send a pull request to the develop branch.

Please make sure that you have set up your user name and email address for use with Git. Strings such as silly nick name <root@localhost> look really stupid in the commit history of a project.

Due to time constraints, you may not always get a quick response. Please do not take delays personal and feel free to remind.

Coding Guidelines

This project comes with a .prettierrc.json configuration file. Please run the following command to format the code before committing it.

$ npm run format

Using setup-php from a Git checkout

The following commands can be used to perform the initial checkout of setup-php:

$ git clone https://github.com/shivammathur/setup-php.git

$ cd setup-php

Install setup-php dependencies using npm:

$ npm install

Running the test suite

After following the steps shown above, The setup-php tests in the __tests__ directory can be run using this command:

$ npm test

Reporting issues

Please submit the issue using the appropriate template provided for a bug report or a feature request: