First time forking a repo, am I doing it right? (Regarding ettiquettes and conventions)

Hello, I’ve been developing some games with Unity. In several projects, I’ve been using a modified version of an open source project “QuickOutline” on GitHub, making it run on a separate thread to not block the main thread.

I thought my modifications would be helpful to some people, so I’m thinking I’ll fork the repo and change the name to “ThreadedQuickOutline” adding features and also fixing some bugs too.

Am I doing this right? Is it okay (or ethical?) to change the name?
Also should I move original Readme.md somewhere else and put mine explaining why my repo exists and what it does? If not, what should I do to state such information?

The original project is licensed under MIT License and it hasn’t been maintained for a couple of years.

Thanks in advance for helping out a complete newb, <3

Changing the name is a good idea, because it avoids people confusing your fork with the older project. There are quite a few open source projects around with name suffixes like “-ng” or “2” because they were forked from inactive projects and the developers wanted to show that they are forks. Being more creative about the name certainly won’t hurt. :wink:

Keeping a note about what you forked from in the Readme is definitely a good idea. If the old code is still around a link is good, too. Whether you do that by editing the old Readme or creating your own mostly depends on whether the old content still makes sense for your changed version (e.g. if it has old usage information that doesn’t apply to your fork any more, there’s little point in keeping it).

It is important that you keep information on the origin of code and its licensing as described in the license itself. Shouldn’t be difficult, but I am not a lawyer.

2 Likes