carpentries-incubator / carpentries-incubator/python-intermediate-development

Improve flow of the lesson in sections 4 and 5

Open
#299 4 comments 0 reactions 1 assignee Claimed by @douglowe View on GitHub
Dominant language
TeX
Stars
63
Forks
77
Avg merge
20h 8m
Merged PRs (30d)
3

Description

A couple of issues:
- do we need to fork the software repo - are we looking at past commits prior to forking at all?
- we talk about releasing the project in section 4, fixing the documentation and readme and then we ask people in section 5 to open issues to fix these exact things
- Exercise [/52-assessing-software-suitability-improvement/index.html#exercise-conduct-assessment-on-third-party-software](https://carpentries-incubator.github.io/python-intermediate-development/52-assessing-software-suitability-improvement/index.html#exercise-conduct-assessment-on-third-party-software) does not make much sense as the code is not developed enough and also all repos are the same
- not sure that comments "### MODIFIED START ###" in code in episode https://carpentries-incubator.github.io/python-intermediate-development/36-architecture-revisited/index.html#adding-a-new-view mean

A better flow could be:

Section 4: Managing a Collaborative Software Project
- Developing Software In a Team: Code Review
- Improving Software Over Its Lifetime
- Issues reporting and tracking
- Software Improvement Through Feedback
- Managing a Collaborative Software Project

Section 5: Releasing and Reusing Software
- Preparing Software for Reuse and Release
- Issue prioritisation
- Planning sprinting and release cycles
- Packaging Code for Release and Distribution

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.