neuroinformatics-unit / course-software-good-practice

Slides for NIU collaborative coding and software development good practices
BSD 3-Clause "New" or "Revised" License
7 stars 0 forks source link

fall 2024 teaching - material update #21

Closed lauraporta closed 1 month ago

lauraporta commented 2 months ago

Description

What is this PR

Why is this PR needed? Reorganize slides order for 2024 fall course

What does this PR do? Changes main index.qmd file, introduces "story approach".

I am keeping the refactoring.qmd (with new material added) and packaging.qmd. I moved the exercised to a suggested section at the end. Links to part of the material (documentation / testing) have been removed, but the qmd files are still there if we want to reuse them.

References

See #20

How has this PR been tested?

Will be tested locally

Is this a breaking change?

No

Does this PR require an update to the documentation?

No

Checklist:

lauraporta commented 1 month ago

@alessandrofelder I've two questions before marking the PR as ready for review:

  1. Should I add also my photo and bio to the slides?
  2. I think we should make the best practices 2023 org just a general best practices org. I don't see the point of making a new org every year. What do you think?
adamltyson commented 1 month ago

Should I add also my photo and bio to the slides?

I would remove photos TBH, the less stuff like this we have, the easier the material is to re-use. No reason why you can't introduce yourself at the beginning :)

I think we should make the best practices 2023 org just a general best practices org. I don't see the point of making a new org every year. What do you think?

100%, we have too many orgs already!

lauraporta commented 1 month ago

Thanks, Adam. So, renaming the org will affect a few links in various repositories. I am going to update those I've access to. But first, I'll wait for the green light by Alessandro.

alessandrofelder commented 1 month ago

happy with removing photos and intro slides, and with renaming org.