From bc42a41ed8aed37de38fccc5127f5339e77a949e Mon Sep 17 00:00:00 2001 From: LBF38 Date: Wed, 23 Aug 2023 20:55:39 +0200 Subject: [PATCH] docs(bot): :memo: update installation.md w/ notes (#714) add an important information note for new repo installation w/ the bot. The config file should be created for the first time w/ mandatory values. The bot will add the default values afterwards. Co-authored-by: Maximilian Berkmann --- docs/bot/installation.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/bot/installation.md b/docs/bot/installation.md index 88f4f63b..62f178fd 100644 --- a/docs/bot/installation.md +++ b/docs/bot/installation.md @@ -49,6 +49,17 @@ For the badge use the following, replacing `projectOwner` with the relevant GitH [![All Contributors](https://img.shields.io/github/all-contributors/projectOwner/projectName?color=ee8449&style=flat-square)](#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 : +> +> ```json +> { +> "projectName": "", +> "projectOwner": "" +> } +> ``` +> + ## 4. Update your Contributing documentation Consider updating your `CONTRIBUTING.md` or similar with steps on how contributors can add themselves. You can even link to the [bot usage documentation](usage).