LifterLMS

LifterLMS, the #1 WordPress LMS solution, makes it easy to create, sell, and protect engaging online courses.

Changelog

Documentation

• https://lifterlms.com/docs/
• https://lifterlms.readme.io

Support

This is a developer's portal for the LifterLMS team and any members of the community who wish to contribute to LifterLMS.

This is not a support form. If you require support please visit the forums or become a LifterLMS Pro Member and submit a support ticket.

Reporting a Bug

Bugs can be reported at https://github.com/gocodebox/lifterlms/issues/new.

Before reporting a bug, search existing issues and ensure you're not creating a duplicate. If the issue already exists you can add your information to the existing report.

Also check our known issues and conflicts for possible resolutions.

Please include as much of the following information as possible:

1. Reproduction Steps

• Include clear and detailed step by step instructions on how the issue can be reliably reproduced
• Include screenshots where applicable
• Record a video if possible

2. Expected Behavior

• Include a concise description of what you expected to happen (but didn't)

3. Error Messages

• Include any error messages reported on screen (or in your logs)

4. Version Information

• Many issues are the result of theme or plugin conflicts. Including information about your WordPress version, your plugins (and their versions), and your theme (and its version) will help us resolve conflicts.
• We've created the LifterLMS System report to help with this. See details on using and obtaining the system report at https://lifterlms.com/docs/how-to-use-the-lifterlms-system-report/

5. Server Details

• Operating system of your webserver
• Webserver in use (Apache, NGINX, IIS, other) and what version
• PHP Version and (extensions if applicable)
• MySQL Version

6. Browser, Device, and Operating System

• If the bug occurs in a specific browser, it is very useful in helping us track down the specifics using this information (as well as version numbers)

Providing as much of this information as possible will help us resolve issues as quickly as possible.

Installing for Development

1. Composer

• curl -sS https://getcomposer.org/installer | php
• php composer.phar install

2. Node

• Install node
• Install npm
• npm install --global gulp
• npm install

Coding Standards

For standards we're working off a modified version of the WordPress Coding Standards.

We're utilizing (a currently slightly modified version of) the WordPress Coding Standards Core Ruleset for PHPCS (php codesniffing).

Our javascript and SCSS are a mess. We're tackling that next.

Running phpcs

Do not use phpcs directly from the command line, use the gulp task.

• gulp phpcs to run on all php files
• gulp phpcs --file path/to/file.php to run on a specific file
• gulp phpcs --file valid/glob/*.php pass a valid glob to run on a group of files
• gulp phpcs --warning 0 to ignore PHPCS warnings, or any valid phpcs warning severity level (1-8)

Running phpcbf

• ./vendor/bin/phpcbf to run on all php files
• ./vendor/bin/phpcbf path/to/file.php to run on a specific file

Contributing

• Fork the repository on GitHub (make sure to use the develop branch, not master).
• Make the changes to your forked repository.
• Ensure you stick to the WordPress Coding Standards and have properly documented any new functions, actions and filters following the documentation standards.
• When committing, reference your issue (if present) and include a note about the fix.
• Run PHPCS and ensure the output has no errors. We will reject pull requests if they fail codesniffing.
• Push the changes to your fork
• Submit a pull request to the 'develop' branch of the LifterLMS repo.
• 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. We're newly open source and supporting users and customers and our own internal pull requests and releases will take priority over pull requests from the community. Please be patient!