KIANMENG / SMS-Send-Mocean-0.02 / CONTRIBUTING.md

CONTRIBUTING

GitHub

Follow these steps to make changes to the repository.

  1. Create a fork of the repository.
  2. Setup your development environment.
  3. Do necessary changes and make sure all tests passed.
  4. Submit a pull request.

Development Environment

Setup your development environment as follows.

Docker

If you have Docker installed, you can build your Docker container for this project.

$ docker build -t sms-send-mocean .
$ docker run -it -v $(pwd):/root sms-send-mocean bash
# cpanm --installdeps --notest .

Milla

Setting up the required packages.

$ milla authordeps --missing | cpanm
$ milla listdeps --missing | cpanm

Check you code coverage.

$ milla cover

Several ways to run the test.

$ milla test
$ milla test --author --release
$ AUTHOR_TESTING=1 RELEASE_TESTING=1 milla test
$ AUTHOR_TESTING=1 RELEASE_TESTING=1 milla run prove t/01_instantiation.t
$ LOGGING=1 milla run prove t/01_instantiation.t

Update the required API parameters into 't/.env.test' file and export these paramters to the current shell.

$ source t/.env.test; milla run prove t/04_send_sms.t
$ source t/.env.test  milla test --author --release

To remove these API parameters from the shell.

$ source t/.env.unset