Issue Guidelines

Serenity is an open source and free to use software. This doesn't mean it comes with unlimited free support.

The author and other contributors already spent thousands of hours to offer you this platform, samples and accompanying docs.

But they don't have unlimited spare time. Still, they are willing to offer some help, given that you also try to help them a bit.

If you call 911 but don't specify your location, they cannot help you. Unless you follow steps here, we also can't.

If your issue is closed and you are redirected here, please try to understand our reasoning, and follow these steps:

• Read the Serenity Guide (which can be found here) and follow the tutorials and how-to section carefully. Most of the time your answer lays there, but you probably missed it.
• Have a look at FAQ and WIKI in this site.
• Make sure you check prior issues first, there is a search functionality in GitHub issues, just type relevant words
• See samples under Basic Samples section of Serene Demo
• If you are getting some error, read the error carefully, the error probably has the info to resolve the issue.
• Check the browser console.
• Check the change log, and recent commits / issues in GitHub. We list breaking changes and steps you should take there.
• Make sure you don't use spaces, special chars, dots, dashes etc. in project name. Use same root namespace, e.g. your solution name in all code you wrote
• Don't report like "it doesn't work", "i got empty page" etc. List all steps you took, any warnings / browser console logs you got.
• Did you check prerequisites listed in Welcome.htm you saw when you created the project? Do you have the correct version of TypeScript? Did you check your NodeJS/NPM version?
• We are not offering support for libraries and languages, tools we use. So issues relevant to Less, TypeScript, SlickGrid, Bootstrap, JsPDF etc. should go to their relevant repositories.

Reporting process

In the event that you have completed all of the above steps and your question is still not answered, report your issue properly. You can start a discussion, or if it is a real issue please make sure you stick to the Issue guide.

• Environment (Windows 7, 8.1, 10, VS 2015, VS 2017 etc.)
• Version (Serenity Version)
• Stack Trace
• What you were trying to do
• When it started to fail, the steps to took to attempt a fix
• Screenshots are always helpful
• Check Browser Console