/lifterlms

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

Primary LanguagePHP

LifterLMS

Build Status Code Climate Test Coverage

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

Changelog

Documentation

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.

Installing for Development

  1. Composer
  • curl -sS https://getcomposer.org/installer | php
  • php composer.phar install
  1. 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

Use the shorthand composer script to run phpcs against all PHP files.

  • composer run-script phpcs

Alternatively access the executable:

  • ./vendor/bin/phpcs path/to/file.php

To see errors only (no warnings):

  • ./vendor/bin/phpcs -n path/to/file.php

To see all options:

  • ./vendor/bin/phpcs -h

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.
  • Create a new branch from the 'master' branch.
  • 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 'master' 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!