Skip to content

Latest commit

 

History

History
36 lines (28 loc) · 2.55 KB

CONTRIBUTING.md

File metadata and controls

36 lines (28 loc) · 2.55 KB

#Contribute To Ninja Forms (adapted from Easy Digital Downloads)

Getting Started

  • 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 (if applicable).
    • If it's a 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 Ninja Forms repository on GitHub
  • From the develop branch on your forked repository, create a new branch and make your changes
    • It is suggested that your new branch use the naming convention issue/{issue#} e.g. issue/190
    • Ensure you stick to the WordPress Coding Standards
  • When committing, use a well-formed commit message
  • Push the changes to your fork and submit a pull request to the develop branch of the Ninja Forms repository

Code Documentation

  • We're working on making sure that every function is documented well and follows the WordPress inline documentation standards based on phpDoc
  • The WordPress Inline Documentation Standards (with examples) can be found here
  • Please make sure that every function is documented so that our API Documentation will be complete
    • 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 Ninja Forms 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.

Additional Resources