docs(bot): 📝 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 <[email protected]>
all-contributors · Aug 23, 2023 · bc42a41 · bc42a41 · Gledis123 · Feb 8, 2024
1 parent dd548de
commit bc42a41
Showing 1 changed file with 11 additions and 0 deletions.
diff --git 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": "<insert the repo's name>",
+> "projectOwner": "<insert the repo's owner/orgs>"
+> }
+> ```
+>
+
 ## 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).