Hi! Thank you for your interest in contributing to the plugin, we really appreciate it.
There are many ways to contribute – reporting bugs, feature suggestions, fixing bugs, submitting pull requests for enhancements.
Just file a GitHub issue, that’s all. If you want to prefix the title with a “Question:”, “Bug:”, or the general area of the application, that would be helpful, but by no means mandatory. If you have write access, add the appropriate labels.
If you’re filing a bug, specific steps to reproduce are helpful. Please include the URL of the page that has the bug, along with what you expected to see and what happened instead.
Here is a handy link for submitting a new bug.
Every plugin is just as good as the documentation. In this repository we offer collaboration with a wiki to create a documentation for this plugin.
If you want to contribute code to the plugin you have to set up the environment locally. Make sure that you have npm and grunt installed.
The working directory is the build directory. If you change shomething in another location of the git the pull request or commit will be ignored.
To test the plugin make a symbolic link between the trunk folder and the wp-content/plugins/afb-instant-articles folder on your local WordPress instance.
Start the grunt watcher with the terminal command grunt watch. Grunt will make sure that the code will be compiled and copied to the trunk folder.
Before committing execute the command grunt deploy to perform a clean deploy from the build to the trunk folder.
IMPORTANT: Edits outside the build directory will be overwritten by the grunt tasks. So make sure you don't work within the trunk folder.