Skip to content

brenoalvs/monk

Repository files navigation

Monk Build Status

Welcome! This is the official repository on GitHub of Monk, a WordPress translation plugin for your content reach the world. Here you can follow the project development and see the new things that are being made. Feel free to look the sources, issues and most importantly, contribute.

Download Monk here

Asking for support

Please use this repository only for core related issues, like bugs, PRs and contributions. If you need user related help, please visit our support page on WordPress.org.

Documentation

Contributing to Monk

If you find any error or have suggestions, contribute with them to improve Monk. They are all welcome, but before anything please take a minute to read our contributor guidelines and code of conduct.

Tests

Tests are in tests directory. To run them you need to install some requirements and configure the test suite.

  1. Install PHPUnit (https://github.com/sebastianbergmann/phpunit#installation).
  2. Install WP-CLI (http://wp-cli.org/#install).
  3. cd to plugin's directory.
  4. Install and configure the test environment running bin/install-wp-tests.sh <db-name> <db-user> <db-pass> [db-host] [wp-version]. E.g.: bin/install-wp-tests.sh wordpress_test root '' localhost latest
  5. Run phpunit and let the tests begin!

Note: Be sure to have svn command installed on your system.

Note: If anything fails running install-wp-tests.sh you'll have to delete /tmp/wordpress* and drop the wordpress_test database to undo what the script does.