Before you open a new issue or ask a question in chat, you must read these guidelines. If it is evident from your issue that you failed to research your question properly, your issue may be closed without being answered.
There are a few common stumbling blocks that new users face when setting up UserFrosting for the first time. If you are new to the current version of UserFrosting, please first look at the troubleshooting page.
If you don't find what you're looking for in the troubleshooting page, then please check the wiki and existing issues, both opened and closed. Your question may have already been asked and answered before!
You can also search for help on Stack Overflow. In addition to the tags for the components that UF builds upon, such as Slim, Twig, Eloquent, jQuery Validate, Select2, there is now a UserFrosting tag as well.
There are also tags for the utilities upon which UserFrosting depends, such as Composer and Git.
In general, the Github issue tracker should only be used for bug reports and feature requests. If you're just having trouble getting something to work, you should ask on Stack Overflow instead. Tag your question with the userfrosting tag, and optionally with any tags specific to the relevant underlying technologies, such as slim, twig, eloquent, composer, etc. You should also mention the version of UserFrosting that you are using.
After posting a question on Stack Overflow, please link to it in chat. This will ensure that more people see it, and provide a place where we can discuss and help clarify your question.
On Github, UserFrosting Chat, and Stack Overflow, please keep in mind the following:
-
Remember that courtesy and proper grammar go a long way. Please take the time to craft a precise, polite issue. We will do our best to help, but remember that this is an open-source project - none of us are getting paid a salary to develop this project, or act as your personal support hotline 😉
-
Report any errors in detail. Vague issues like "it doesn't work when I do this" are not helpful. Show that you have put some effort into identifying the cause of the error.
-
There are two main places where you may find error messages:
-
Backend (PHP-related) errors: in your PHP error log. This is usually a file called
php_error_logor something like that. In XAMPP, the default location of this file isXAMPP/xamppfiles/logs/. For other web hosting platforms, please consult the documentation or do a quick Google search (i.e. "where is the php error log in _____"). Some web hosts may provide a special interface for accessing the php error log, through ssh, cpanel, etc. Please ask them directly for help with this. -
Frontend (Javascript-related) errors: in your browser's Javascript console. This can be accessed from "Tools->Web Developer" menu in Firefox, or "More tools->Javascript Console" in Chrome. For help with other browsers, please Google "where is the javascript console in ____".
You should also try testing your code in a local development environment, to separate code-related issues from server issues. In general, we recommend that you install a local development server on your computer, rather than testing your code directly on the production server. This means you can test your code directly on your own computer, making development faster and without the risk of exposing sensitive information to the public. We recommend installing XAMPP if you don't already have a local server set up.
When making a pull request, set your "base branch" to the hotfix-development branch. Accepted pull requests will be merged into master in batches with a new hotfix number as needed. This will allow us to keep track of which version number every change belongs to, which is useful when tracking down other users' issues.
When submitting code, make sure to add feature/major changes to README.md and all changes to CHANGELOG.md.