We welcome contributions and suggestions to help us improve this project. You can always create issues on this repository to suggest changes or improvements. We actively add our own issues to the list, and comment on their progress. Further, you can always email us at [email protected].
In our initial setup documentation and in subsequent instructions for developers, we detail how to install the plugin and the developer tools it requires for various tasks. Follow these developer instructions. If you are familiar with the command line already, here are the various requirements:
Most developers will want to install Composer. You'll need to have the composer executable in your path, or be able to call it in another way (one recommended way of doing this is Homebrew).
If you intend to contribute interface work, for example on the admin settings design, or translation work, to translate all or some of the plugin's text into another language, you will need Node.js and Gulp installed as well. You can use this guide to set it up, and this plugin already includes a package.json and Gulpfile.js.
You'll need to run gulp in the plugin's main directory if you make changes to Sass, JavaScript, or when you create new translations.
Note: if you would like to contribute translation work but are uncomfortable using Node and Gulp in this way, you can always submit your changes as one or more issues instead. Please indicate what the text you want to translate currently says, where in the plugin you can find it, what it should say in the additional language, and of course what language it is.
If your contribution is PHP work, it may be relevant to the code documentation. In that case, you may want to install phpDocumentor to generate this documentation. You can use this link to set it up.
Run phpDocumentor.phar (or however you call the file) in the plugin's root directory when you make relevant changes. For example, if you have this file installed in your ~/Sites directory, you would run php ~/Sites/phpDocumentor.phar. You can check these changes in to the Git repository.
- Use WordPress Coding Standards for CSS, HTML, JavaScript, and PHP, whenever possible. If you see places we've missed these, feel free to fix as long as nothing breaks. When pull requests are submitted, they'll be automatically reviewed by the minncodebot, which runs the PHPCS Code Review GitHub Action. Pull requests are also checked against the repository's Scrutinizr and Code Climate configurations, and you'll see those results after they finish running.
- Use markdown syntax for all text documents.
- We'd appreciate tests, either for new or existing functionality, but as we don't currently have any this is certainly not a requirement.
- Fork this repository
- Create a branch (
git checkout -b my-branch) - Stage and commit your changes (
git commit -am 'description of my changes') - Push the changes to your fork (
git push origin my-branch) - Submit a pull request to the parent repository.
- Pull requests should be assigned to:
- @jonathanstegall (primary)