Skip to content

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

Discussion options

You must be logged in to vote
Lumeriith:

Am I doing this right? Is it okay (or ethical?) to change the name?

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. 😉

Lumeriith:

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?

Keeping a note about what you forked from in the Readme is definitely a good ide…

Replies: 1 comment

Comment options

You must be logged in to vote
0 replies
Answer selected
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
2 participants