Contributions to GiveWP are more than welcome.
By contributing code to GiveWP, you agree to license your contribution under the GPL License.
Search our issue tracker first to see if the bug has already been reported. When opening a new issue:
- Specify the version number for GiveWP.
- Describe the problem in detail. Explain what happened, and what you expected would happen. Include a screenshot if helpful.
Do not report potential security vulnerabilities here. You can report security bugs through the Patchstack Vulnerability Disclosure Program. The Patchstack team helps validate, triage, and handle any security vulnerabilities.
See the README for prerequisites, the Docker-based quick start, local development setup, and build commands.
- PHP follows the PSR-12 coding standard rather than the WordPress coding standards.
- JavaScript and styles follow the
.eslintrcand.editorconfigrulesets in the repository root — your editor should pick these up automatically. - Docblocks use
@sincetags. For new or changed code, use@since TBD— it's replaced with the version number at release time.
/**
* @since TBD
*/
public function myNewMethod()From the plugin root:
composer testSee tests/README.md for environment setup and how to filter to specific tests. Tests also run automatically via GitHub Actions on every pull request.
- Fork the repository on GitHub and make your changes on a branch.
- Before opening the PR, check that:
- All PHPUnit tests pass (
composer test). - Your code follows PSR-12 and the
.eslintrc/.editorconfigrulesets. - New or changed code has
@since TBDdocblock tags. - You've added a changelog entry with
composer run changelog:add— this drops a YAML file into./changelogthat gets compiled intoreadme.txtat release time. Commit it with your PR. PRs prefixed withTests:that only add or change tests do not need a changelog entry. - There's no leftover debug code (
var_dump(),console.log()) and/wp-content/debug.logstays empty while testing your changes.
- All PHPUnit tests pass (
- Submit the pull request to the
developbranch, referencing the related issue if there is one. - Prefix the PR title with the type of change, e.g.
Feature: add donation form export,Fix: prevent duplicate receipts, orEnhancement: improve settings copy. UseTests:for a PR that only touches tests.
We review all pull requests and will make suggestions and changes if necessary.
- When integrating with payment gateways, make sure all data relevant to the gateway goes directly to the gateway and nowhere else — especially credit card data.
- Under no circumstances should payment method details (i.e. credit card details) be stored on the server.