Pemasangan Bot
1. Pasang Aplikasi AllContributors GitHub
2. Konfigurasikan repositori kamu
README.md
3. Buat Ensure you have a README.md
file at the root of the project (it can be empty).
Jika kamu lebih memilih tabel kontributor berada di tempat lain selain README.md
; setelah merging PR bot pertama kamu, kamu bisa memindahkan table kontributor kamu, periksa files
di konfigurasi bot
Make sure to add this in the markdown:
For the list:
## Contributors
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->
Note: Extra line is very important in order to make it work properly.
For the badge use the following, replacing projectOwner
with the relevant GitHub username or organization name, and projectName
with the relevant the GitHub repo name. Style, color, and other parameters can be customized to your liking — see https://shields.io/.
[](#contributors)
Please create the
.all-contributorsrc
file for the first configuration. It can only have the mandatory information in it to begin. The bot will update it automatically with default config in the first PR. Here is the minimal.all-contributorsrc
file to add in your repo :
{ "projectName": "<insert the repo's name>", "projectOwner": "<insert the repo's owner/orgs>" }
4. Perbarui dokumentasi Berkontribusi kamu
Pertimbangkan untuk memperbarui CONTRIBUTING.md
kamu atau yang semisal dengan langkah-langkah tentang bagaimana kontributor dapat menambahkan diri mereka sendiri. Kamu juga bisa mentautkan ke dokumentasi penggunaan bot.