theopensourceway / guidebook

Guidebook of open source community management best practices; is somewhat opinionated.
Other
170 stars 42 forks source link

Write a chapter on migrating code #32

Open semioticrobotic opened 4 years ago

semioticrobotic commented 4 years ago

Compose a guidebook chapter on the finer points of code migration. Topics may include:

quaid commented 3 years ago

It's not clear that this chapter as conceived fits the focus of the community.

There is some historical reasoning for why the 1.0 version went into some detail on these matters. Part of the evolution of open source development since then is that more ways of healthy code maintenance are understood, better tools, different POVs, etc.

There is some material we'll put elsewhere that covers this material, in terms of the healthy community definition—having docs, having code testing, having a public repo, etc. The more detailed viewpoint in this chapter idea may not fit the guidebook, although there may be more that can be said after deeper consideration and research on the topic.

I'm leaving the issue open so the idea remains viable, but am removing it from the chapter outline and the editorial board for the 2.0 release and for the current view of what belongs in that guidebook.

quaid commented 3 years ago

After discussion in the meeting today, we think this may represent some remnant of the 1.0 guide that was a bit more pedantic about specific code and packaging recommendations. The evolution in open source since then indicates we should reconsider at what level this chapter operates and is needed.

Some content about must-haves such as a source repository and documentation are covered in other chapters.

There may be room for some content around this, but we didn't feel it belongs in the guidebook at this time. I'm leaving issue open as an idea that can be reconsidered in the planning for 2.1.