Project takeover protocol

2011-04-01 Thread Sergio Tulentsev
Hi fellow coders,

There's this project, which his original author didn't work on for
last 2 years (and doesn't plan to). The project is missing some
important functionality that I need. So, naturally, I forked the repo
and started hacking.
Soon I realized that I need to make changes that will potentially
break all the clients out there (if any).

How do I go about this?
* clearly state in README that the code is not backward-compatible
with the original.
* push it as a separate project.

-- 
You received this message because you are subscribed to the Google Groups 
GitHub group.
To post to this group, send email to github@googlegroups.com.
To unsubscribe from this group, send email to 
github+unsubscr...@googlegroups.com.
For more options, visit this group at 
http://groups.google.com/group/github?hl=en.



Re: Project takeover protocol

2011-04-01 Thread Chris Mear
On 2 Apr 2011, at 00:03, Sergio Tulentsev sergei.tulent...@gmail.com wrote:

 There's this project, which his original author didn't work on for
 last 2 years (and doesn't plan to). The project is missing some
 important functionality that I need. So, naturally, I forked the repo
 and started hacking.
 Soon I realized that I need to make changes that will potentially
 break all the clients out there (if any).
 
 How do I go about this?
 * clearly state in README that the code is not backward-compatible
 with the original.
 * push it as a separate project.

There's no need to start a separate project, but you should:

* make the backwards-incompatible changes clear in the README (and the 
CHANGELOG if you have one);
* update the major version number ( http://semver.org/ ); and
* make a branch for the old version line, so that people can get to it if they 
want to (e.g. v1.x).

Chris

-- 
You received this message because you are subscribed to the Google Groups 
GitHub group.
To post to this group, send email to github@googlegroups.com.
To unsubscribe from this group, send email to 
github+unsubscr...@googlegroups.com.
For more options, visit this group at 
http://groups.google.com/group/github?hl=en.



Re: Project takeover protocol

2011-04-01 Thread Sergei Tulentsev
Thanks, Chris.

On Sat, Apr 2, 2011 at 3:51 AM, Chris Mear chrism...@gmail.com wrote:

 On 2 Apr 2011, at 00:03, Sergio Tulentsev sergei.tulent...@gmail.com
 wrote:

  There's this project, which his original author didn't work on for
  last 2 years (and doesn't plan to). The project is missing some
  important functionality that I need. So, naturally, I forked the repo
  and started hacking.
  Soon I realized that I need to make changes that will potentially
  break all the clients out there (if any).
 
  How do I go about this?
  * clearly state in README that the code is not backward-compatible
  with the original.
  * push it as a separate project.

 There's no need to start a separate project, but you should:

 * make the backwards-incompatible changes clear in the README (and the
 CHANGELOG if you have one);
 * update the major version number ( http://semver.org/ ); and
 * make a branch for the old version line, so that people can get to it if
 they want to (e.g. v1.x).

 Chris

 --
 You received this message because you are subscribed to the Google Groups
 GitHub group.
 To post to this group, send email to github@googlegroups.com.
 To unsubscribe from this group, send email to
 github+unsubscr...@googlegroups.com.
 For more options, visit this group at
 http://groups.google.com/group/github?hl=en.




-- 
Best regards,
Sergei Tulentsev

-- 
You received this message because you are subscribed to the Google Groups 
GitHub group.
To post to this group, send email to github@googlegroups.com.
To unsubscribe from this group, send email to 
github+unsubscr...@googlegroups.com.
For more options, visit this group at 
http://groups.google.com/group/github?hl=en.