Thanks for wanting to be a part of this library! This is a simple and standard guide to assist in how to contribute to this project.
Well, you can:
- Tackle any open issues
- Help review pull requests
You don't have to be a superstar, or someone with experience, you can just dive in and help if you feel you can.
Its best to:
- Fork the repository (see adding upstream below)
- Create a branch such as
cool-new-feature - Create your code
- Create and run successfull tests (see testing below)
- Submit a pull request
Its best to:
- Ensure the bug was not already reported by searching all issues.
- If you're unable to find an open issue addressing the problem, open a new one.
- Be sure to include a title and clear description, as much relevant information as possible.
Its best to:
- Fork the repository (see adding upstream below)
- Create a branch such as
issue-(issuenumber)-fix - Create your code
- Create and run successfull tests (see testing below)
- Submit a pull request
- Comment on the issue
If you're forking the repository and wish to keep your copy up-to-date with the master, ensure you run this command:
git remote add upstream git@github.com:gnikyt/basic-shopify-api.git
You can then update by simply running:
git checkout master && git pull upstream master
We use PHPUnit to run tests. Simply run composer install and a symlink phpunit should be located in the bin directory.
Next, run bin/phpunit and the rest will be taken care of. Upon any pull requests and merges, TravisCI will check the code to ensure all test suites pass.
Thats it! Enjoy.