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.

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

Explain how to edit an existing julia package, submit PRs, etc. #100

Open
4 tasks
jlperla opened this issue Sep 3, 2021 · 0 comments
Open
4 tasks

Explain how to edit an existing julia package, submit PRs, etc. #100

jlperla opened this issue Sep 3, 2021 · 0 comments

Comments

@jlperla
Copy link
Member

jlperla commented Sep 3, 2021

This can go in the testing lecture and rely on the version control one

  • Reminder on how to fork and clone. Create branch.

  • Ensure the tests run!

  • Pointer to test only dependencies and the two ways to do it.

  • In your GLOBAL environment, do ] add TestEnv

  • clone the package.

  • open the folder in vscode, and start a Julia REPL, which should be activating the main Project.toml file.

  • If you haven't already, do a ]test to ensure you have installed whatever packages the test dependencies need
    (I don't think you need to add it to the global environment unless you are tewsting it with the another repo. If so, then you can do the following to add it to the global environment:
    ] activate
    ] dev .
    which should make this a deved proejct without cloning it to .julia/dev which I personally hate.... but doesn't matter how you do it.
    )

  • Then anytime you want to work in the vscode repo and use the inline evlauation on the unit tests/etc. you just need to run the following code when opening that REPL (which, presumably, activates the project file for the repo since you start there):
    using TestEnv; TestEnv.activate()

  • After that, you should be good to go. For examples, include("test/runtests.jl") should work, etc.

Need to check if this works for the test-only dependencies in the main file, or just the ones in the test/Project.toml.

  • Maybe point out the documentation and explain how to edit/compile it?

Also tell people the expectation of createing PRs for projects (e.g. run regressoin tests, add unit tests, update the documentation as appropriate, etc.).

@jlperla jlperla added this to the sciml+1.9 release milestone Dec 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant