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

Rethink development practices lesson #8

Open
lucaferranti opened this issue Apr 23, 2021 · 3 comments
Open

Rethink development practices lesson #8

lucaferranti opened this issue Apr 23, 2021 · 3 comments

Comments

@lucaferranti
Copy link

I propose to rethink the "development practices" leeson. A few possibly interesting topics for the lesson (not necessarily in a good order):

  1. Contributing to existing packages
  2. Dissection of Julia package structure
  3. using Revise.jl to test and develop packages
  4. creating new packages using PkgTemplates.jl
  5. tips and tricks: startup.jl, @edit macro and similar

Moreover, I think that a jupyter notebook cannot capture the essence of these topics, hence this lesson might be more a "live coding" using VScode and julia REPL. If some supporting written material is needed, there could be just a html page explaining the previous steps with REPL snippets etc.

A good inspiration resource might be this video, although that's maybe a little outdated since it uses atom.

@FabsOliveira
Copy link

FabsOliveira commented Apr 26, 2021

I would add to 4. the idea of working on personal projects as packages, which intersects with #2 too. Knowing how to handle environments, what they actually mean ("a folder with a project.toml" and a "manifest.toml"), handling dependencies, using commands such as dev and activate, and the difference to a global environment are topics that come to my mind.

@rantahar
Copy link

rantahar commented Aug 9, 2021

Thanks for the ideas. I reworked the section to include creating packages and the some discussion of the standard structure, but decided there is not time to go into details.

Still, it's worth a discussion. I wonder if there is anything that could be dropped in favor of this?
We could also write an extended section for interested students and 2-day courses.

@lucaferranti
Copy link
Author

I guess for this time, you could just point interested students to the seminar series event "package development in Julia" which is taking place the week after. On the long run, we could integrate that as an advanced lesson here

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants