Move the Contributor Table
The contributor table goes into README.md by default. In a project with many contributors, the table can take over the README, and you may prefer to give it a file of its own. The same steps also let you show the table in several files, for example in the README and on a documentation page. This guide moves the table to CONTRIBUTORS.md.
-
Create the file and add the markers
Create
CONTRIBUTORS.mdand add the table markers where the table should appear. Every file you list must exist, or adding a contributor fails, and it needs the markers, or the table never shows up in it. -
List the file in the configuration
In
.all-contributorsrc, setfilesto the new file:{"files": ["CONTRIBUTORS.md"]}To show the table in several files, list them all, for example
["README.md", "CONTRIBUTORS.md"]. A configuration can list up to 25 files. -
Clean up the README
Remove the old table and its markers from
README.md. A table that stays behind is no longer updated. The specification recommends a prominent link from the README to the file with the table. -
Commit the changes
Commit the new file,
.all-contributorsrcandREADME.mdto your default branch. The next time a contributor is added, the whole table is written toCONTRIBUTORS.md.
