winglang / winglang/wing

Contributor guide - compiler Q&As

Open
#516 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

👷‍♀️ contributor-experience 📚 documentation 🛠️ compiler
Dominant language
TypeScript
Stars
5.4k
Forks
215
Avg merge
2h 9m
Merged PRs (30d)
27

Description

Migrate the information from https://github.com/winglang/wing/blob/main/libs/wingc/CONTRIBUTING.md into the root CONTRIBUTING.md so that all of the information is in one place for contributors. Some possible questions:

  • How do I build the compiler?
  • How do I update snapshot tests?
  • How do I profile the compiler? (cc @3p3r)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read libs/wingc/CONTRIBUTING.md and compare it with the root CONTRIBUTING.md. Consolidate the compiler contributor information, including build, snapshot-test, and profiling guidance, in the root guide. Done means contributors can find all of this information in one place.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust, typescript
Domain
compilers, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
54/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.