Skip to content

Latest commit

 

History

History
56 lines (29 loc) · 2.34 KB

CONTRIBUTING.md

File metadata and controls

56 lines (29 loc) · 2.34 KB

Contributing to Dianoga

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

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 Sitecore StackExchange using the tag dianoga. Or reach out on Sitecore Slack

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 - you can open an issue, or reach out on Sitecore Slack

Reporting Issues

Have you identified a reproducible problem in Dianoga? 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.

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.

Please include the following with each issue:

  • Version of Dianoga

  • Environment description

  • What configs you have enabled

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

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

  • Relevant logs

Thank You!

Your contributions to open source, large or small, make great projects like this possible. Thank you for taking the time to contribute.