-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update dependencies, improve cards and contribs documentation
- Loading branch information
1 parent
cad5442
commit 37d2e4d
Showing
6 changed files
with
118 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -75,6 +75,26 @@ following example: | |
|
||
Contributors are matched by email address, and the image is used if configured. | ||
|
||
## Adding information with txt files | ||
|
||
In some cases contributors information cannot be obtained from Git history: | ||
for example following a history rewrite, or because contributors for a page | ||
are not competent in Git, and contributed in ways that are not visible in the | ||
commit history. For these situations, the contribs plugin supports adding more | ||
information using `*.contribs.txt` files, with a structure like the following: | ||
|
||
``` | ||
# Comment | ||
Charlie Brown <[email protected]> (3) | ||
Sally Brown <[email protected]> (1) | ||
Roberto Prevato <[email protected]> (10) | ||
``` | ||
|
||
The name of the .txt files must match the name of the page: | ||
|
||
- `example.md` | ||
- `example.contribs.txt` | ||
|
||
## Under the hood | ||
|
||
This plugin works by using the following `git` commands, to obtain contributors | ||
|
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters