Skip to content

Latest commit

 

History

History
76 lines (45 loc) · 4.86 KB

CONTRIBUTING.md

File metadata and controls

76 lines (45 loc) · 4.86 KB
Raw

Contributing to Radzen.Blazor

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

This is a set of guidelines for contributing to Radzen.Blazor.

Asking questions

Please don't open an issue to ask a question about using Radzen.Blazor components. You can check the following resources instead:

A showcase application that demonstrates all Radzen.Blazor components. You will find various use cases that demonstrate the component features and API. The source of the demos is available here.

Technical documentation and API reference.

You can ask your question here. Please use the Radzen.Blazor Components category.

  • Dedicated technical support

Radzen staff provides technical support with guaranteed response time to Radzen Professional and Enterprise subscribers. The pricing options are available here.

How Can I Contribute?

Reporting bugs

We are tracking bugs as issues.

Before creating bug reports, please check the existing issues as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible. Fill out the required template, the information it asks for helps us resolve issues faster.

Note: If you find a Closed issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.

How Do I Submit A (Good) Bug Report?

After you've determined your bug hasn't been reported yet, create an issue in this repository and provide the following information by filling in the template.

Explain the problem and include additional details to help maintainers reproduce the problem:

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as many details as possible.
  • Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use Markdown code blocks.
  • Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
  • Explain which behavior you expected to see instead and why.
  • Include screenshots and animated GIFs which show you following the described steps and clearly demonstrate the problem. You can use this tool to record GIFs on macOS and Windows, and this tool or this tool on Linux.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion 📝 and find related suggestions 🔎.

After you've determined your feature hasn't been requested yet, create an issue in this repository and provide the following information by filling in the template.

Explain the enhancement and include additional details:

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Provide specific examples to demonstrate the steps. Include copy/pasteable snippets which you use in those examples, as Markdown code blocks.
  • Describe the current behavior and explain which behavior you expected to see instead and why.
  • Explain why this enhancement would be useful to most Radzen.Blazor users.

Pull Requests

If you want to contribute a new feature of fix a bug you can open a pull request.

Make sure you follow this procedure:

  • Be sure that none of the existing tests breaks after your changes. The test project is available here.
  • If possible add new tests that verify your fix or new feature.
  • Follow the existing coding style (to be described in detail later).