Skip to content

Latest commit

 

History

History
38 lines (24 loc) · 1.71 KB

CONTRIBUTING.md

File metadata and controls

38 lines (24 loc) · 1.71 KB

Contributing to Give

Contributions to Give are more than welcome.

License

By contributing code to Give, you agree to license your contribution under the GPL License.

Before reporting a bug

Search our issue tracker for similar issues.

  • Do not report potential security vulnerabilities here. Email them privately to our security team at [email protected]

How to report a bug

  1. Specify the version number for Give.
  2. Describe the problem in detail. Explain what happened, and what you expected would happen.
  3. If helpful, include a screenshot. Annotate the screenshot for clarity.

How to contribute to Give

If you would like to submit a pull request, please follow the steps below:

  • Make sure you have a GitHub account
  • Fork the repository on GitHub
  • Make changes to your fork of the repository
  • Ensure you stick to the WordPress Coding Standards
  • When committing, reference your issue (if present) and include a note about the fix
  • Push the changes to your fork and submit a pull request to the 'master' branch of the Give repository

Code Documentation

  • We ensure that every Give function is documented well and follows the standards set by phpDoc
  • If you're adding/editing a function in a class, make sure to add @access {private|public|protected}
  • Finally, please use tabs and not spaces. The tab indent size should be 4 for all Give code.

At this point you're waiting on us to merge your pull request. We'll review all pull requests, and make suggestions and changes if necessary.