Skip to content

Latest commit

 

History

History
113 lines (79 loc) · 4.23 KB

CONTRIBUTING.md

File metadata and controls

113 lines (79 loc) · 4.23 KB
Raw

Contributing

Contributions are welcome. We accept pull requests on GitHub.

This project adheres to a Contributor Code of Conduct. By participating in this project and its community, you are expected to uphold this code.

Team members

Communication Channels

You can find help and discussion in the following places:

Reporting Bugs

Bugs are tracked in our project's issue tracker.

When submitting a bug report, please include enough information for us to reproduce the bug. A good bug report includes the following sections:

  • Expected outcome
  • Actual outcome
  • Steps to reproduce, including sample code
  • Any other information that will help us debug and reproduce the issue, including stack traces, system/environment information, and screenshots

Please do not include passwords or any personally identifiable information in your bug report and sample code.

Fixing Bugs

We welcome pull requests to fix bugs!

If you see a bug report that you'd like to fix, please feel free to do so. Following the directions and guidelines described in the "Adding New Features" section below, you may create bugfix branches and send us pull requests.

Adding New Features

If you have an idea for a new feature, it's a good idea to check out our issues or active pull requests first to see if we are being working on the feature. If not, feel free to submit an issue first, asking whether the feature is beneficial to the project. This will save you from doing a lot of development work only to have your feature rejected. We don't enjoy rejecting your hard work, but some features just don't fit with the goals of the project.

When you do begin working on your feature, here are some guidelines to consider:

  • Your pull request description should clearly detail the changes you have made.
  • Follow our code style using squizlabs/php_codesniffer and friendsofphp/php-cs-fixer.
  • Please write tests for any new features you add.
  • Please ensure that tests pass before submitting your pull request. Running the tests locally will help save time.
  • We have GitHub Actions automatically running tests for pull requests.
  • Use topic/feature branches. Please do not ask us to pull from your main branch.
  • Submit one feature per pull request. If you have multiple features you wish to submit, please break them up into separate pull requests.
  • Send coherent history. Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting.

Installing development tools

This project uses different development tools to ensure code style, test and quality (using code analyzers).

# install project direct dependencies
composer install

# install development tools
phive update

Check the code style

If you are having issues with coding standards use php-cs-fixer and phpcbf

# using composer
composer dev:fix-style

# or using tools individually
tools/php-cs-fixer fix -v
tools/phpcbf -sp

Running Tests

The following tests must pass before we will accept a pull request. If any of these do not pass, it will result in a complete build failure. Before you can run these, be sure to composer install or composer update.

# using composer
composer dev:build

# or using tools individually
tools/phpcs -sp
tools/php-cs-fixer fix -v --dry-run
vendor/bin/phpunit --testdox
tools/phpstan analyze

Running GitHub Actions locally

You can use act to run your GitHub Actions locally. As documented in actions/setup-php-action you will need to execute the command as:

act -P ubuntu-latest=shivammathur/node:latest