Databases
StackOverflow2013
Postsdbo
POHow to announce backward incompatible changes in OSS project?
Body
 

Note that there are some explanatory texts on larger screens.

plurals
  1. POHow to announce backward incompatible changes in OSS project?
    text
    copied!<p>Sometimes you need to introduce backward incompatibile changes, when the improvements far outweighs the downsides. It is possible to easily switch to old behavior, but the user must be aware of such changes.</p> <p>Therefore the question is: <strong>how to announce future backward incompatible changes to FLOSS (open source) project</strong>, so that users can prepare for them, and either change their use, or configure program to use old behavior.</p> <p>Because it is OSS project, it is packaged by various distributions independently, and might be upgraded automatically without user intervention. And then backward incompatible change might mess somebodys workflow (third party scripts for example).</p> <p>Avenues currently considered (and used):</p> <ul> <li>project mailing list</li> <li>project homepage</li> <li>release notes (first warning, then announcement)</li> <li>maintainer's blog</li> </ul> <p><strong>Edit 1:</strong> This (backward incompatible) change would happen in some <em>major</em> release. </p> <p>All changes are about either adding safeguards (refusing commands which can thoroughly confuse newbie users), or changing defaults to more sane values.</p> <p><strong>Edit 2:</strong> In the transition period the default configuration (which is meant to be changed to default refuse/deny) is changed to <em>warn</em>, with description how to turn of a warning, which also would protect against backward incompatibile change in default behavior.</p> <p>But if it is automated system that might not help...</p> <hr> <p><em>The project in question is <a href="http://git-scm.com" rel="nofollow noreferrer">Git</a>, distributed version control system;<br> see <a href="http://gitster.livejournal.com/28129.html" rel="nofollow noreferrer">Giving early warning to users</a> at <a href="http://gitster.livejournal.com" rel="nofollow noreferrer">gitster's journal</a> (Junio C Hamano blog)</em></p>
 

Querying!

 
Guidance
An individual column

Larger individual text columns get their own page to allow for proper reading.

SQuiL has stopped working due to an internal error.

If you are curious you may find further information in the browser console, which is accessible through the devtools (F12).

Reload