Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Should I change author in package.json after forking and improving a Github repo?

I forked someone's repo and added functionality. The amount I contributed is just under half of all the functionality it now has.

In the fork in package.json, his name is still in the author field.

Should I change the author field to myself and add him as a contributor to the contributors field? Or should I leave the author field AS-IS and add me as a contributor?

like image 580
Christiaan Westerbeek Avatar asked Jan 27 '19 18:01

Christiaan Westerbeek


People also ask

What happens when we fork a repository?

A fork is a copy of a repository. Forking a repository allows you to freely experiment with changes without affecting the original project.

What happens when you fork in GitHub?

A fork is a copy of a repository that you manage. Forks let you make changes to a project without affecting the original repository. You can fetch updates from or submit changes to the original repository with pull requests.

What are some common reasons to fork a Git project?

Forking a repository allows you to freely experiment with changes without affecting the original project. Most commonly, forks are used to either propose changes to someone else's project or to use someone else's project as a starting point for your own idea.

How do you fork someone's repository?

You can fork any repo by clicking the fork button in the upper right hand corner of a repo page. Click on the Fork button to fork any repo on github.com. Source: GitHub Guides.


1 Answers

So I just ran into this as well. Going off of @juanriqgon's comment, you could add contributors (in order of who contributed the most - maybe adding a note to the package for that).

{
  "contributors" : [
  {
    "name" : "Barney Rubble",
    "email" : "[email protected]",
    "url" : "http://barnyrubble.tumblr.com/"
  },  
  {
    "name" : "Newton Bubble",
    "email" : "[email protected]",
    "url" : "http://newtonbubble.tumblr.com/"
  }
 ]
}

source: https://docs.npmjs.com/cli/v7/configuring-npm/package-json#people-fields-author-contributors

hope this helps the community!

like image 57
Nissal Avatar answered Sep 28 '22 08:09

Nissal