Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add the contribution guide #142

Merged
merged 12 commits into from
Sep 30, 2022
Merged

Add the contribution guide #142

merged 12 commits into from
Sep 30, 2022

Conversation

NeilKleistGao
Copy link
Member

Related Issue: #137

  • Add error message when TypeScript is not installed
  • Add Getting Started Guide in README.md

@NeilKleistGao
Copy link
Member Author

Tell me if more details need to be added. 😺

@LPTK LPTK requested a review from chengluyu September 30, 2022 04:48
chengluyu
chengluyu reviewed Sep 30, 2022
View reviewed changes
README.md Outdated Show resolved Hide resolved
@LPTK
Copy link
Contributor

LPTK commented Sep 30, 2022

Cool! You can also mention that individual tests can be run with -z. For example, ~mlscriptJVM/testOnly mlscript.DiffTests -- -z parser will watch for file changes and continuously run all parser tests (those that have "parser" in their name).

chengluyu
chengluyu requested changes Sep 30, 2022
View reviewed changes
ts2mls/js/src/main/scala/ts2mls/TSCompilerInfo.scala Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Cunyuan(Holden) Gao and others added 3 commits September 30, 2022 13:16
@chengluyu
Update README.md
8cddcc5 
Co-authored-by: Luyu Cheng <luyu.cheng@connect.ust.hk>
@chengluyu
Update README.md
a835c4f 
Co-authored-by: Luyu Cheng <luyu.cheng@connect.ust.hk>
@NeilKleistGao
Add -z test
2cb4880
LPTK
LPTK approved these changes Sep 30, 2022
View reviewed changes
Copy link
Contributor

@LPTK LPTK left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks! But before you merge (by squashing and cleaning up the commit message), please describe the -z way as the main way to run individual tests (put it first). The other way is more of an ugly hack.

@NeilKleistGao NeilKleistGao marked this pull request as ready for review September 30, 2022 07:33
@NeilKleistGao
Copy link
Member Author

Seems I can't merge before Luyu review again. 🤔

@chengluyu
Copy link
Member

Wait a second. I have some changes.

@chengluyu chengluyu changed the title Add Comprehensive Contribution Guide Add the contribution guide Sep 30, 2022
@chengluyu chengluyu merged commit b73d7f2 into hkust-taco:mlscript Sep 30, 2022
@NeilKleistGao NeilKleistGao deleted the npm branch August 29, 2023 11:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@LPTK LPTK LPTK approved these changes

@chengluyu chengluyu chengluyu approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@NeilKleistGao @LPTK @chengluyu