winglang/wing

First-time contributor environment check script

Open

#1,932 创建于 2023年3月29日

在 GitHub 查看
 (5 评论) (2 反应) (0 负责人)TypeScript (214 fork)github user discovery
good first issue✨ enhancement👷‍♀️ contributor-experience

仓库指标

Star
 (5,385 star)
PR 合并指标
 (30 天内没有已合并 PR)

描述

Community Note

Please vote by adding a 👍 reaction to the issue to help us prioritize. If you are interested to work on this issue, please leave a comment.

Feature Spec

When someone first tries to contribute to Wing, it is possible that even after forking the repository and setting up any required tools, they may see errors when they run npm run build. Usually these errors are hard to debug because they may be due to either a missing tool, or a tool being installed with a wrong version.

To minimize this pain, we can add a short script that runs before everything else which checks if all required tools (node, rust, docker, etc.) are ready and available on the user's system with the correct versoins.

Checklist:

  • OS
  • Node version
  • Npm version
  • Rust version
  • Rustfmt version(?)
  • Docker installed and running

If any of the items in the check list fail, we can throw an error (overridable via environment variable) and provide some helpful messaging about how to fix the given issue.

Use Cases

Improve the first time contributing experience

Implementation Notes

No response

Component

Contributor Experience

贡献者指南