Updates to the training material
Following the Bootcamp that took place between 4-8 November 2024, the following changes could be made to improve the material:
-
The students such
forkand thenclonethe forked copy of the repository (add inREADME), -
Update the README to make sure that information has been updated now that the material is located in this new
lpc-devrepo, -
In the first notebook: add an example showing how to resolve a merge conflict (and even how such a conflict could arise),
-
In the second notebook regarding merge requests:
- Make sure reviewer/ other team members are added to the repository,
- Appropriate source/ target branches are specified,
-
Also in second notebook:
- Add diagram at start summarising the software development "workflow"
- Material too dense?
- Make discussion about code style/PEP8 less sense and Python-centric,
- Very little time left for performing the code review. What/where can I cut?
-
For the future, possibly as additional notebooks:
git lfs- Publishing code (write a README, add a License,
conda/mamba, CI/CD, issues (prioritization, milestones etc)