Skip to main content

Engine Issue Guidelines

Submit issues at: https://github.com/alibaba/lowcode-engine/issues

Read Before Submitting​

Because the engine project is complex, maintainers cannot spend much time on reproduction and communication. Please describe reproduction steps as clearly as possible.

image.png

What you think an issue looks like

image.png

What we see in an issue

To collaborate effectively, we prioritize engine issues as follows. Please read carefully Orz.

  • [Fast support] Reproducible via online Demo URL + API input in the console.
  • [Fast support] Reproducible via online Demo + imported schema
  • [Slower support] Reproducible via online Demo + complete operation steps
  • [Slower support] Reproducible via online Demo + code changes, with clear location and content of the changes
  • [Slow support] Full project URL that can be cloned, dependencies installed, and started to reproduce
  • [Slow support] For feature requests, due to limited capacity we welcome PRs. If you explain background, context, and scenarios clearly, the maintainers can more easily suggest approaches or direction.
  • [Support not guaranteed] Other cases
    • Title only, no reproduction steps
    • Unclear reproduction steps
    • Unrelated to the engine

Examples by Priority​

[Fast support] Reproducible via online Demo URL + API input in the console.​

Example image.png Reproduction steps:

  • Open the online demo
  • In the console, enter:
// Current doc
const doc = window.AliLowCodeEngine.project.currentDocument

// Create a new doc and switch successfully
window.AliLowCodeEngine.project.openDocument({
    componentName: 'Page'
});

// Cannot switch back
window.AliLowCodeEngine.project.openDocument('docl4xkca5b')

Expected behavior:

  • openDocument should switch back to the original doc normally

[Fast support] Reproducible via online demo + imported schema​

Steps:

  • Use the online demo
  • Import the schema below
  • Schema code / schema zip archive
  • Page appears as follows

Expected:

  • The xxx part of the page does not match expectations; the expected result is xxx

[Slower support] Reproducible via online demo + complete operation steps​

Example

  1. Use antd component image.png

  2. Drag this component image.png

  3. Set this property value to 100 image.png

Expected behavior:

  • Component matches the configuration

[Slower support] Reproducible via online demo + code changes, with clear location and content of the changes​

Example image.png

image.png

image.png

image.png

[Slow support] Full project URL that can be cloned, dependencies installed, and started to reproduce​

Full projects contain a lot of noise; investigating them is very time-consuming and difficult. This approach is not recommended.

[Support not guaranteed] Other​

Title only, no reproduction steps​

image.png

Unclear reproduction steps​

image.png

Unrelated to the engine​

image.png

Further Reading​

We strongly recommend How To Ask Questions The Smart Way, How to Ask Questions in Open Source Communities, How to Report Bugs Effectively, and How to Submit Unanswerable Questions to Open Source Projects. Better questions get help faster. (This section references antd.)