-
Notifications
You must be signed in to change notification settings - Fork 6
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.
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
Add Dev Workflow Docs #301
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅ |
Performance Ratio:
|
1. Ensure that you have Revise.jl and TestEnv.jl installed in your default environment. | ||
1. start the REPL, `dev` Mooncake.jl, and navigate to the top level of the Mooncake.jl directory. | ||
1. `using TestEnv, Revise`. Better still, load both of these in your `.julia/config/startup.jl` file so that you don't ever forget to load them. | ||
1. Run the following: `using Pkg; Pkg.activate("."); TestEnv.activate(); include("test/front_matter.jl");` to set up your environment. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
not a suggestion, just a anecdotal point from me: I configure VSCode to automatically do the Pkg.activate()
for the package folder I open. But what you wrote is better as it assumes less.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for letting me know -- this is good to know.
All make sense, thanks Will. I use VSCode REPL integration quite often, particularly |
Thanks for the review @sunxd3 -- I'll merge when CI passes. |
Addresses #268 . @sunxd3 would you mind taking a quick look at this and letting me know if it is clear? I feel like you have most experience developing Mooncake after me, so you are likely best positioned to judge this.