While there is no formal contribution process, feel free to contribute by:
- Creating issues, bug reports or feature requests on Github
- Submitting pull requests for improvements
Pull requests should be submitted to the develop
branch to be included in the next release.
To install development dependencies for magedbm2, run:
make install
magedbm2 follows PSR-2 for code style and a set of rules from phpmd to check for code problems.
You should run the following to check for any potential issues with the code before committing it:
make lint
Issue 1: Cannot declare class PHPCompatibility\Sniffs\Lists\NewKeyedListSniff, because the name is already in use
This will appear if you've contributed before the upgrade to 4.0.0 having had phpcs set up and your next contribution was after the upgrade to 4.0.0.
Fix: ./vendor/bin/phpcs --config-set installed_paths vendor/phpcompatibility/php-compatibility
magedbm2 is tested with PHPUnit. 100% code coverage is not required, but all significant parts should have unit tests.
Make sure that the full suite of tests passes before committing changes by running:
make test
If applicable, update the CHANGELOG.md
with your change, following the Keep a Changelog standard.
You can build the magedbm2 phar archive with Box by running:
make build
To release a new version of magedbm2:
-
Build the phar archive
-
Update the
manifest.json
file with the new version information-
Use
https://github.com/space48/magedbm2/releases/download/<version>/magedbm2.phar
as the URL -
To calculate the sha1 checksum of the phar archive, run:
sha1sum magedbm2.phar
-
-
Update the Installation instructions above with the new version
-
Create a release on Github