The required coding standards represent the best practices for enabling a consistent code style across the team. As the way we work evolves over time, our coding standards likewise need to evolve.
For changing or adding rules please start a new issue and/or submit a pull request for discussion.
All notable changes to this project must be documented in the CHANGELOG.md file. The format is based on Keep a Changelog and this project adheres to Semantic Versioning.
The project consists of one PHP package (published on packagist.org) and two JavaScript packages (published on npmjs.com). All packages must be published with the same version.
For dependent package management this project uses Lerna.
If you haven't yet, run npm install.
Lerna automatically releases all outdated packages. To check which packages are outdated and will be released, type npm run publish:check.
If you have the ability to publish packages, you must have 2FA enabled. Confirm that you're logged in to npm, by running npm whoami. If you're not logged in, run npm adduser to login.
Run the following command to release a dev version of the outdated packages.
npm run publish:devLerna will ask you which version number you want to choose for all packages. For a dev release, you'll more likely want to choose the "prerelease" option.
Lerna will then publish to npm, commit the package.json changes and create the git tags.
Note: If Lerna doesn't detect any changes since only the PHP package was updated use --force-publish.
npm run publish:dev -- --force-publishTo release a production version for the outdated packages, run the following command:
npm run publish:prodChoose the correct version based on the CHANGELOG.md file, confirm your choices and let Lerna do its magic.