Skip to content

Latest commit

 

History

History
82 lines (43 loc) · 3.95 KB

CONTRIBUTING.md

File metadata and controls

82 lines (43 loc) · 3.95 KB
Raw

Contributing to Katalon Analytics

Welcome, and thank you for your interest in contributing to Katalon Analytics!

There are many ways in which you can contribute, beyond writing code. The goal of this document is to provide a high-level overview of how you can get involved.

Asking Questions

Have a question? Rather than opening an issue, please ask away on Forum.

The active community will be eager to assist you. Your well-worded question will serve as a resource to others searching for help.

Providing Feedback

Your comments and feedback are welcome, and the development team is available via a handful of different channels.

Reporting Issues

Have you identified a reproducible problem in Katalon Analytics ? Have a feature request? We want to hear about it! Here's how you can make reporting your issue as effective as possible.

Look For an Existing Issue

Before you create a new issue, please do a search in open issues to see if the issue or feature request has already been filed.

Be sure to scan through the most popular feature requests.

If you find your issue already exists, make relevant comments and add your reaction. Use a reaction in place of a "+1" comment:

  • 👍 - upvote
  • 👎 - downvote

If you cannot find an existing issue that describes your bug or feature, create a new issue using the guidelines below.

Writing Good Bug Reports and Feature Requests

File a single issue per problem and feature request. Do not enumerate multiple bugs or feature requests in the same issue.

Do not add your issue as a comment to an existing issue unless it's for the identical input. Many issues look similar, but have different causes.

The more information you can provide, the more likely someone will be successful at reproducing the issue and finding a fix.

The built-in tool for reporting an issue, which you can access by using Report Issue in Katatlon Analytics's Feeback menu, can help streamline this process by automatically providing the feedback template with needed fields.

Please include the following with each issue:

  • Version of Katalon Studio, Browser Version

  • Reproducible steps (1... 2... 3...) that cause the issue

  • What you expected to see, versus what you actually saw

  • Images, animations, or a link to a video showing the issue occurring

  • A code snippet that demonstrates the issue or a link to a code repository the developers can easily pull down to recreate the issue locally

    • Note: Because the developers need to copy and paste the code snippet, including a code snippet as a media file (i.e. .gif) is not sufficient.

  • Errors from the Dev Tools Console

Final Checklist

Please remember to do the following:

  • Search the issue repository to ensure your report is a new issue

  • Simplify your step around the issue to better isolate the problem

Don't feel bad if the developers can't reproduce the issue right away. They will simply ask for more information!

Follow Your Issue

Once submitted, your report will go into the issue tracking workflow. Be sure to understand what will happen next, so you know what to expect, and how to continue to assist throughout the process. We use a bot to help us manage issues. This bot currently:

  • Automatically closes any issue marked needs-more-information if there has been no response in the past 7 days.
  • Automatically locks issues 45 days after they are closed.

If you believe the bot got something wrong, please open a new issue and let us know.

Thank You!

Your contributions to us make great projects like this possible. Thank you for taking the time to contribute.