Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
61 lines (39 loc) · 3.01 KB

CONTRIBUTING.md

File metadata and controls

61 lines (39 loc) · 3.01 KB
Raw

Contributing

Thank you for helping improve WebUI. The project is still in active development, so the best way to contribute right now is by opening high-quality issues that document bugs, feature needs, and documentation gaps.

Pull requests are paused

We are not accepting unsolicited pull requests at this time. Please do not open a pull request unless a maintainer explicitly asks for one. Unsolicited pull requests may be closed without review so maintainers can focus on stabilizing the project.

If a maintainer invites a pull request for a focused change, most contributions require a Contributor License Agreement (CLA). The CLA bot will guide you through the process. For details, visit https://cla.opensource.microsoft.com.

Issues we welcome

  • Bugs with clear reproduction steps.
  • Feature requests that explain the need and expected outcome.
  • Documentation issues that identify confusing, missing, or incorrect guidance.

Before opening an issue, search the existing issues to avoid duplicates. Use one issue per bug, feature, or documentation need. Provide as much detail as you can, but do not let a missing version number or code sample stop you from reporting a useful issue.

Start from the GitHub issue template chooser, or use a matching form directly:

Bugs

When reporting a bug, include:

  • A short summary of the problem.
  • A minimal reproduction. Prefer a WebUI Playground share link from https://microsoft.github.io/webui/playground/ when the issue can be reproduced there. Otherwise, include a sample repository or small code snippet.
  • Exact steps to reproduce the problem.
  • Expected behavior and actual behavior.
  • Environment details such as OS, Rust version, Node.js version, package version, and command used.
  • Relevant logs, stack traces, or terminal output.

Feature requests

When requesting a feature, include:

  • The problem or need you are trying to solve.
  • Who would benefit from the feature.
  • A concrete example of the desired API, CLI behavior, or workflow.
  • Any constraints that matter, especially performance, security, compatibility, or migration concerns.
  • Workarounds or alternatives you considered.

Documentation issues

When reporting a documentation need, include:

  • The page, section, or workflow that was confusing or missing.
  • What you expected to find.
  • What information would have helped.
  • Suggested wording or examples, if you have them.

Security issues

Do not report security vulnerabilities through public GitHub Issues. Follow the reporting process in SECURITY.md.

Code of Conduct

This project follows the Microsoft Open Source Code of Conduct.