Skip to content

Commit dff4931

Browse files
fpozzobontimvink
authored andcommitted
Adding documentation of co_authors and set to false by default
1 parent ad20883 commit dff4931

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

docs/options.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ plugins:
88
show_contribution: true
99
show_line_count: true
1010
show_email_address: true
11-
add_co_authors: true
11+
add_co_authors: false
1212
href: "mailto:{email}"
1313
count_empty_lines: true
1414
fallback_to_empty: false
@@ -45,6 +45,12 @@ If this option is set to `true` (default: `true`), then authors' names
4545
are rendered as (by default) a `mailto:{email}` link pointing to their email address. If
4646
set to `false`, they are shown in plain text.
4747

48+
## `add_co_authors`
49+
50+
If this option is set to `true` (default: `false`), then
51+
[co-authors](https://docs.github.com/en/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors)' names
52+
are rendered in addition to the commit author.
53+
4854
## `href`
4955

5056
Given `show_email_adress` is set to `true`, you can customize the rendered link with the option `href`

0 commit comments

Comments
 (0)