Skip to content

How to report an issue

Bradley Dilger edited this page Dec 2, 2021 · 43 revisions

Contents

Thank you for using CIABATTA. If you have any problems with the software that we’ve created or the scripts that we’ve written, we ask that you share that information with us using GitHub. That is the best way for us to work with our developers to solve the problem.

If you have a question about using CIABATTA, a suggestion for us, or other things to share, we invite you to email us. Please know that because we are offering CIABATTA as a free resource, we may not be able to provide direct assistance to you.

Create a GitHub account if needed

To report an issue, you need a Github account. If you don’t already have one, create one here: https://github.com/signup

After you are signed in your GitHub account, select the Issues tab.

Issues tab

Look for similar issues already reported

After opening the Issues tab, you will see a list of previously reported issues.

Please review this list and see if any of the issues are similar to the one you are experiencing. If so, you will add to that existing issue.

If none of the issues look like yours, you will submit a new issue.

Report your issue

There are two ways to report issues on GitHub. In either case, please be specific and detailed. Please tell us the CIABATTA page where you discovered the issue, and the name of the script or resource which does not seem to be working correctly.

If you can share a screenshot, that is often very helpful, too.

Add to an existing issue

If you found a previous issue, select the issue which is like yours on the Issues tab.

You’ll see previous comments by other CIABATTA users. Please take a moment to review those comments, then add a comment of your own that shares your experience and builds on what the previous CIABATTA users said.

Submit a new issue

If you found a new issue, please select the “New issue” button.

This should open an editor window, as in the screenshot below, where you can summarize your issue.

Screenshot: Adding a new issue

To add a screenshot or attachment, simply drag it into the editing window.

After you submit your issue

Crow developers will review the issue you raise and will contact you via GitHub when it is resolved, or if more information will be helpful.

Again, because we are providing CIABATTA as a free resource, this may take some time.