Skip to content

Latest commit

 

History

History
40 lines (30 loc) · 2.69 KB

CONTRIBUTE.md

File metadata and controls

40 lines (30 loc) · 2.69 KB
Raw

#Contribute to Paid Memberships Pro

Paid Memberships Pro is the "community solution" for membership sites on WordPress, and so contributions of all kinds are appreciated.

When contributing, please follow these guidelines to ensure things work as smoothly as possible.

Please Note: GitHub is for bug reports and contributions only. If you have a support or customization question, go to our Member Support Page instead.

Getting Started

  • Do not report potential security vulnerabilities here. Email them privately to [email protected] with the words "Security Vulnerability" in the subject.
  • Submit a ticket for your issue, assuming one does not already exist.
    • Raise it on our Issue Tracker
    • Clearly describe the issue including steps to reproduce the bug.
    • Make sure you fill in the earliest version that you know has the issue as well as the version of WordPress you're using.

Making Changes

  • Fork the repository on GitHub
  • For bug fixes, checkout the latest versioned branch of the PMPro repository (e.g. 1.8.9.3).
  • For new features and enhancements, checkout the DEV branch of the PMPro respository.
  • Make the changes to your forked repository
  • When committing, reference your issue (if present) and include a note about the fix
  • Push the changes to your fork
  • For bug fixes, submit a pull request to the latest versioned branch of the PMPro repository (e.g. 1.8.9.3).
  • For new features and enhancements, submit a pull request to the DEV branch of the PMPro repository.
  • We will process all pull requests and make suggestions or changes as soon as possible. Feel free to ping us politely via email or social networks to take a look at your pulls.

Code Documentation

  • We would like for every function, filter, class, and class method to be documented using phpDoc standards.
  • An example of how PMPro uses phpDoc blocks can be found here.
  • Please make sure that every function is documented so that when we update our API Documentation things don't go awry!
    • 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 EDD code.

Additional Resources