This is the contribute.md of our project. Great to have you here. Here are a few ways you can help make this project better!
If you'd like to add a new feature, please submit a pull request!
- Follow the WordPress coding standards for your coding style.
- End files with a newline.
- Document liberally using PHPDoc
- Explain "Why" not "What"
- Document why a function works the way it does, not what it does.
- Please include tests when submitting new features or verifying bug fixes.
- Use the present tense ("Add feature" not "Added feature")
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
- Limit the first line to 72 characters or less
- Reference issues and pull requests liberally
- Consider starting the commit message with an applicable emoji:
- 🎨
:art:when improving the format/structure of the code - 🐎
:racehorse:when improving performance - 🚱
:non-potable_water:when plugging memory leaks - 📝
:memo:when writing docs - 🐛
:bug:when fixing a bug - 🔥
:fire:when removing code or files - 💚
:green_heart:when fixing the CI build - ✅
:white_check_mark:when adding tests - 🔒
:lock:when dealing with security - ⬆️
:arrow_up:when upgrading dependencies - ⬇️
:arrow_down:when downgrading dependencies - 👕
:shirt:when removing linter warnings
- 🎨
If you'd like to help out and provide a translation, or improve string outputs, your work will be greatly appreciated!