Thanks for helping improve Eloom LMS. Bug reports, fixes, documentation and new features are all welcome.
Open a GitHub issue. For a bug, include:
- the steps to reproduce it
- what you expected to happen and what happened instead
- your PHP and MySQL versions
- any relevant lines from
storage/logs/laravel.log, with personal data removed
Security issues are the exception. Report them privately, as described in SECURITY.md.
- Fork the repository and create a branch from
main, e.g.fix/offer-letter-pdforfeature/sms-notifications. - Follow the README to set up a local environment.
- Keep each change focused. One pull request should solve one problem.
- Match the style of the surrounding code:
- Put new functionality in the module it belongs to, or create a new module with
php artisan module:make <Name>. - Protect admin controllers with
$this->middleware('auth:user')and check permissions withcheckRole('<key>', '<action>'), as the existing controllers do. - Change the schema through a new migration. Never edit an existing one.
- Read deployment-specific values (URLs, keys, names) from config/
.env. Don't hardcode them.
- Put new functionality in the module it belongs to, or create a new module with
- Run the tests before you push:
php artisan test - Open a pull request that explains what changed and why. Add screenshots for UI changes.
Use short, imperative subject lines, e.g. Add payment details to offer settings.
By contributing, you agree that your contributions are licensed under the MIT License.