Skip to content

Latest commit

 

History

History
52 lines (27 loc) · 2.37 KB

CONTRIBUTING.md

File metadata and controls

52 lines (27 loc) · 2.37 KB
Raw

Contributing to Harmony

Welcome, and thank you for your interest in contributing to the Harmony library!

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 the Discord Server.

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

Reporting Issues

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

  • Information about your operating system and .NET environment

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

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

  • 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.

Thank You!

Your contributions to open source, large or small, make projects like this possible. Thank you for taking the time to contribute and consider to become a supporter here at GitHub or as a Patreon.