Bug reports, patches, translations and any kind of contributions are very welcome. When contributing, please ensure you stick to the following guidelines.
When writing a bug report...
- open an issue
- follow the guidelines specified in the issue template
We will take a look at your issue and either assign it keywords and a milestone or get back to you if there are open questions.
When contributing code...
- fork the
main
branch of the repository on GitHub - make changes to the forked repository
- write code that is backward-compatible with WordPress 4.7 and PHP 7.0
- make sure you stick to the WordPress coding standards
- make sure you document the code properly
- test your code with the constant
WP_DEBUG
enabled
- when committing, in addition to a note about the fix, please reference your issue (if present)
- push the changes to your fork and submit a pull request to the
main
branch - follow the guidelines specified in the pull request template
After that we will review the pull-request as soon as possible and either merge it, make suggestions on improvements or ask you for further details about your implementation.
Contributions to this project must be accompanied by a Contributor License Agreement. You (or your employer) retain the copyright to your contribution; this simply gives us permission to use and redistribute your contributions as part of the project. Head over to https://cla.developers.google.com/ to see your current agreements on file or to sign a new one.
You generally only need to submit a CLA once, so if you've already submitted one (even if it was for a different project), you probably don't need to do it again.
When providing translations...
- visit our project on translate.wordpress.org and sign in with your wordpress.org account (create one if you haven't yet)
- select the language you would like to contribute to
- provide the missing translations
- make sure you follow the guidelines outlined in the Translator Handbook
- stick to the translation conventions for your locale (if there are any) - you can find these here
After having provided translations, a translation editor will review your submissions soon and approve them as appropriate.
This project follows Google's Open Source Community Guidelines.