test/BootstrapBlazor3
1
0
Fork 0
mirror of https://gitee.com/LongbowEnterprise/BootstrapBlazor.git synced 2024-12-01 19:50:31 +08:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity
main
BootstrapBlazor3/docs/repro.md
Argo f3d1c2cda7
chore: update comment label action and repro document (#399) 
* chore: fix can not assign assignee on issue

* chore: update checkout action version

* chore: update action branch

* chore: update action and jobs name

* chore: update action add null check

* doc: add repro document

* chore: update comment issue action
2023-01-27 16:36:26 +08:00

2.0 KiB
Raw Permalink Blame History

Bug Report Reproduction Guide

When customers plan to report an issue with BootstrapBlazor, we will most likely ask them to provide a so called minimal reproduction project (repro). This serves two purposes:

  • It helps issue reporters validate their assumptions by trying to recreate the behavior in a new project.
  • It helps eliminate ambiguity and speeds up investigations. We may also be able to provide workarounds in certain scenarios.

This document describes what a minimal repro project is, and why it's important to us.

What is a minimal repro project?

A repro (or a reproduction) is a project, which can be used to reproduce the reported behavior with minimal effort from a product team, which has the minimum code required to demonstrate the concerning behavior.

There are two ways you can provide a minimal repro project. The first and simpler option is to use some type of public web-hosted REPL-based environment which supports ASP.NET Core. The other option is to provide a project hosted in GitHub as described below:

  • Create a new project, based on one of the Blazor Server/WebAssembly project templates.
    • Please use the Empty* project templates if they're available for that project type.
  • Add the minimum amount of code necessary to reproduce the behavior you are reporting on this newly created project.
  • Make sure you do not add any dependencies that are irrelevant to the behavior.
  • Host the project as a public repository on GitHub.
  • Make sure you haven't included any binaries in your project (this is usually about the bin and obj folders in your project) Note: that this step is important and we won't be able to open zip attachments in your issues. Zip files are potential attack vectors that we try to avoid at all cost.

Important considerations

  • Never include any sensitive information in your reproduction project.
  • Never include any code that is not intended to be public in a repro.
  • Do not reference any external services or data sources.