README Integration
To get help generating an integration like this or this, follow these steps:
Install Macdown to make it easy to compare PRs in the last step
Install
opencollective-setup
Get a personal token from GitHub's token page. Check all the
repo
related permissions.Create a file in your home directory (on Mac OS X or Linux) called
.opencollective.json
and add token in it:Run cli for a given repo:
Ex: To integrate with MochaJS (https://github.com/mochajs/mocha), run:
-i
makes it interactive.Answer questions asked by the script - usually defaults are good to go with. Verify that the slug of the project is the same as the one in the database (script guesses at it and is usually right).
Script attempts to do several integrations across README.md, CONTRIBUTORS.md and ISSUE_TEMPLATE.md. The most important ones are the two integrations on README.md: backers and sponsor badges at the top and adding backer/sponsor section near the bottom.
Last updated