winglang/wing

First-time contributor environment check script

Open

#1.932 aberto em 29 de mar. de 2023

Ver no GitHub
 (5 comments) (2 reactions) (0 assignees)TypeScript (214 forks)github user discovery
good first issue✨ enhancement👷‍♀️ contributor-experience

Métricas do repositório

Stars
 (5.385 stars)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

Description

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

Guia do colaborador