Skip to content

Latest commit

 

History

History
63 lines (42 loc) · 2.79 KB

CONTRIBUTING.md

File metadata and controls

63 lines (42 loc) · 2.79 KB
Raw

Contribution Guide

Bug Reports

To encourage active collaboration, php-repos strongly encourages pull requests, not just bug reports. Pull requests will only be reviewed when marked as "ready for review" (not in the "draft" state) and all tests for new features are passing. Lingering, non-active pull requests left in the "draft" state will be closed after a few days.

However, if you file a bug report, your issue should contain a title and a clear description of the issue. You should also include as much relevant information as possible and a code sample that demonstrates the issue. The goal of a bug report is to make it easy for yourself - and others - to replicate the bug and develop a fix.

Remember, bug reports are created in the hope that others with the same problem will be able to collaborate with you on solving it. Do not expect that the bug report will automatically see any activity or that others will jump to fix it. Creating a bug report serves to help yourself and others start on the path of fixing the problem. If you want to chip in, you can help out by fixing any bugs listed in our issue trackers. You must be authenticated with GitHub to view all of php-repos issues.

Support Questions

php-repos GitHub issue trackers are not intended to provide php-repos help or support. Instead, use the GitHub Discussions channel.

Core Development Discussion

You may propose new features or improvements of existing php-repos behavior in the php-repos repository's GitHub discussion board. If you propose a new feature, please be willing to implement at least some of the code that would be needed to complete the feature.

Security Vulnerabilities

If you discover a security vulnerability within php-repos, please email Morteza Poussaneh. All security vulnerabilities will be promptly addressed.

Code of Conduct

In order to ensure that the php-repos community is welcoming to all, please review and abide by the Code of Conduct.

Installation for Contributors

In order to install phpkg for contributing, follow these steps:

git@github.com:php-repos/phpkg.git
cd phpkg
git submodule init
git submodule update

Code Style

Please use snake_case syntax for variables and functions to follow PHP's code style.

Running tests

In order to run tests for contributing, run the following command:

./test-runner

If you need to run tests on a specific file, you can use the filter argument on the test runner:

./test-runner --filter=YourTestFileTest