Thank you for investing your time in contributing to our module! Any contribution you make helps us make this project better. There are a number of sections that cover various different contribution methods. Make sure to review the one that's right for your type of contribution.
Found a bug in our module? Raise an issue with the appropriate template and we'll look into it! Please add any notes that you believe will be helpful to our team in determining a solution for the issue.
After your changes are ready for review, raise a PR with your branch against master!
ℹ️ If you are releasing a patch for a version on LTS/STS, please branch off of the appropriate stable release branch or tag. When your PR is ready for review, raise the PR against the stable release branch. If one doesn't exist, ask the maintainers to create one.
Ready to release? Great! This repository has a number of versioned files which are
managed with Changelogger; in order to
perform a release, you'll need to run changelogger upgrade (patch|minor|major)
(shorthand cl up). Once you've added any relevant Changelog notes, make sure
the changes made by changelogger look good. If they do, commit your changes and
push them to your branch.
When this PR is merged into master, the new version will trigger a release.
ℹ️ This project does not have an automated release pipeline. To perform a full release, review the Internal docuementation.
This repository uses pre-commit to verify changes
before commiting them. Pre-commit will be run for each pull request raised
against release branches, but should also be setup on your local. Follow the
steps to install pre-commit from their website.
Once this is done, run pre-commit install from the root of this project.
Our Magento 2 module has a number of versioned files (i.e. files that include
versioning data). Changelogger automates
the upgrade for each of these files and manages updates to our changelog. You can
install Changelogger with pip: pip install changelogged.
ℹ️ Changelogger requires Python 3.10 or higher.
- Please follow this help center guide to setup Magento 2 instance with the Klaviyo Module
🚧 We're currently overhauling our testing capabilities. Thank you for your patience while we improve this process.
For internal use: See TP168874.