MMG Checkout Payment is a WordPress plugin that integrates with WooCommerce to provide a secure payment gateway for MMG Merchants. This guide is for developers who want to contribute to the project.
- WordPress 6.0+
- WooCommerce 7.0+
- PHP 7.4+
- mbstring extension
- Familiarity with WordPress plugin development
- Understanding of payment gateway integrations
- Knowledge of RSA encryption/decryption
-
Configure devbox on your local machine.
-
Clone the repository:
git clone https://github.com/Kalpa-Services/mmg-wp-plugin.git
-
Navigate to project directory. Doing so should automatically install all the required environment dependencies. If not run
devbox install
. -
Run
composer install
project dependencies. -
Run
devbox services up
to start all services. -
Run
mysql -u root
to connect to the database and create a new database for wordpress. -
Create a new directory called
wordpress
indevbox.d
and run the following commands inside it:curl -O https://wordpress.org/latest.tar.gz tar -xzvf latest.tar.gz mv wordpress/* . rm -rf wordpress latest.tar.gz
-
Configure your wp-config.php file and navigate to
http://localhost:8082
to complete the WordPress setup. -
Navigae to
devbox.d/wordpress/wp-content/plugins
and run the following command:ln -s /path/to/project/mmg-wp-plugin mmg-checkout-payment
-
Activate plugin in the WordPress admin panel.
- Follow WordPress Coding Standards (https://developer.wordpress.org/coding-standards/wordpress-coding-standards/)
- Use meaningful variable and function names
- Comment your code thoroughly, especially complex logic
- Run
composer lint
to check for coding standards violations
- Ensure all new features or bug fixes include appropriate unit tests
- Test the plugin with various WordPress and WooCommerce versions
- Verify compatibility with popular WordPress themes
- Create a new branch for your feature or bug fix
- Make your changes and commit them with clear, concise commit messages
- Push your branch and create a pull request
- Ensure your PR description clearly explains the changes and their purpose
- Never commit sensitive information (API keys, passwords) to the repository
- Follow WordPress security best practices (https://developer.wordpress.org/plugins/security/)
- Be cautious when handling user data and payment information
- Update the README.md file with any new features or changes to installation/configuration steps
- Document any new functions or classes using PHPDoc standards
For questions or support, please open an issue on the GitHub repository or contact the maintainers directly.
This project is licensed under GPL v2 or later. Ensure all contributions comply with this license.