From d237bf149c08cb511c08e6f570149e0392ee94e2 Mon Sep 17 00:00:00 2001 From: Alexander Cyon Date: Tue, 4 Feb 2020 15:39:17 +0100 Subject: [PATCH] Adding .mailmap (#14) Renaming file `CONTRIBUTORS.txt` -> `CONTRIBUTORS.md` Updating MARKDOWN format Adding reference to mailmap docs. --- .mailmap | 2 ++ CONTRIBUTORS.txt => CONTRIBUTORS.md | 9 +++++++-- scripts/generate_contributors_list.sh | 7 ++++--- 3 files changed, 13 insertions(+), 5 deletions(-) create mode 100644 .mailmap rename CONTRIBUTORS.txt => CONTRIBUTORS.md (58%) diff --git a/.mailmap b/.mailmap new file mode 100644 index 00000000..1ec38294 --- /dev/null +++ b/.mailmap @@ -0,0 +1,2 @@ +Alexander Cyon +Tomer Doron \ No newline at end of file diff --git a/CONTRIBUTORS.txt b/CONTRIBUTORS.md similarity index 58% rename from CONTRIBUTORS.txt rename to CONTRIBUTORS.md index 5a0e9d4e..aa7ae091 100644 --- a/CONTRIBUTORS.txt +++ b/CONTRIBUTORS.md @@ -11,8 +11,13 @@ needs to be listed here. ### Contributors +- Alexander Cyon +- Austin Conlon - Cory Benfield +- George Barnett +- Tomer Doron -**Updating this list** +## Updating this list -Please do not edit this file manually. It is generated using `./scripts/generate_contributors_list.sh`. If a name is misspelled or appearing multiple times: add an entry in `./.mailmap` +Please do not edit this file manually. It is generated using `./scripts/generate_contributors_list.sh`. + If a name is misspelled or appearing multiple times: add an entry in `./.mailmap` (see [docs](https://git-scm.com/docs/git-shortlog#_mapping_authors)) diff --git a/scripts/generate_contributors_list.sh b/scripts/generate_contributors_list.sh index 0cb1d72f..858f3413 100755 --- a/scripts/generate_contributors_list.sh +++ b/scripts/generate_contributors_list.sh @@ -17,7 +17,7 @@ set -eu here="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" contributors=$( cd "$here"/.. && git shortlog -es | cut -f2 | sed 's/^/- /' ) -cat > "$here/../CONTRIBUTORS.txt" <<- EOF +cat > "$here/../CONTRIBUTORS.md" <<- EOF For the purpose of tracking copyright, this is the list of individuals and organizations who have contributed source code to SwiftCrypto. @@ -33,7 +33,8 @@ cat > "$here/../CONTRIBUTORS.txt" <<- EOF $contributors - **Updating this list** + ## Updating this list - Please do not edit this file manually. It is generated using \`./scripts/generate_contributors_list.sh\`. If a name is misspelled or appearing multiple times: add an entry in \`./.mailmap\` + Please do not edit this file manually. It is generated using \`./scripts/generate_contributors_list.sh\`. + If a name is misspelled or appearing multiple times: add an entry in \`./.mailmap\` (see [docs](https://git-scm.com/docs/git-shortlog#_mapping_authors)) EOF