Skip to content

Commit bc42a41

Browse files
LBF38Berkmann18
andauthored
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 <maxieberkmann@gmail.com>
1 parent dd548de commit bc42a41

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

docs/bot/installation.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,17 @@ For the badge use the following, replacing `projectOwner` with the relevant GitH
4949
[![All Contributors](https://img.shields.io/github/all-contributors/projectOwner/projectName?color=ee8449&style=flat-square)](#contributors)
5050
```
5151

52+
> 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.
53+
> Here is the minimal `.all-contributorsrc` file to add in your repo :
54+
>
55+
> ```json
56+
> {
57+
> "projectName": "<insert the repo's name>",
58+
> "projectOwner": "<insert the repo's owner/orgs>"
59+
> }
60+
> ```
61+
>
62+
5263
## 4. Update your Contributing documentation
5364
5465
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).

0 commit comments

Comments
 (0)