contributor - print contributor List (only supports git)

contributor command will print the list of people who have modified code or documentation in a git project. The release page contains packages in .deb, .rpm, and .apk formats.

$ cd <PROJECT_ROOT_DIR>
$ contributor 
+-------------------------+-----------------------------------------------------------+-----------+-----------+
|          NAME           |                           EMAIL                           | +(APPEND) | -(DELETE) |
+-------------------------+-----------------------------------------------------------+-----------+-----------+
| Ichinose Shogo          | shogo82148@gmail.com                                      |     11042 |      6044 |
| Daisuke Maki            | lestrrat+github@gmail.com                                 |       866 |       223 |
| Songmu                  | y.songmu@gmail.com                                        |       237 |        65 |
| Stefan Tudose           | stefan.tudose@data4life.care                              |        14 |        12 |
| mattn                   | mattn.jp@gmail.com                                        |         9 |         9 |
| yusuke-enomoto          | yusuke.enomoto@dena.com                                   |         8 |         6 |
| pyros2097               | pyros2097@gmail.com                                       |         3 |         1 |
| catatsuy                | catatsuy@catatsuy.org                                     |         2 |         2 |
| Shoma Okamoto           | 32533860+shmokmt@users.noreply.github.com                 |         1 |         1 |
| nasa9084                | nasa.9084.bassclarinet@gmail.com                          |         1 |         1 |
| dependabot-preview[bot] | 27856297+dependabot-preview[bot]@users.noreply.github.com |         0 |         0 |
+-------------------------+-----------------------------------------------------------+-----------+-----------+

How to install

Step.1 Install golang

contributor command only supports installation with $ go install. If you do not have golang development environment installed on your system, please install golang from the golang official website.

Step.2 Install contributor

$ go install github.com/nao1215/contributor@latest

Generate Contributors.md

The --file option generates Contributors.md in Markdown format.

$ contributor --markdown 
|          NAME           |                           EMAIL                           | +(APPEND) | -(DELETE) |
|-------------------------|-----------------------------------------------------------|-----------|-----------|
| Ichinose Shogo          | shogo82148@gmail.com                                      |      5642 |      1074 |
| Tatsuro Furusawa        | fur.sax.smallworld@gmail.com                              |        14 |         4 |
| Shoma Okamoto           | 32533860+shmokmt@users.noreply.github.com                 |         1 |         1 |
| dependabot-preview[bot] | 27856297+dependabot-preview[bot]@users.noreply.github.com |         0 |         0 |

Auto-generate Contributors.md in GitHub Actions

If you want to automatically create Contributors.md in GitHub Actions, put .github/workflows/contributor.yml in your project.

name: Contributors

on:
  push:
    branches: [main]
  pull_request:
    branches: [main]

jobs:
  contributors:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
        with:
          fetch-depth: 0

      - name: Set up Go
        uses: actions/setup-go@v2
        with:
          go-version: "1.18"

      - name: Generate Contributors
        run: |
          go install github.com/nao1215/contributor@latest
          git remote set-url origin https://github-actions:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}
          git config --global user.name "${GITHUB_ACTOR}"
          git config --global user.email "${GITHUB_ACTOR}@users.noreply.github.com"
          contributor --file
          git add .; \
          git commit -m "Update Contributors List"; \
          git push origin HEAD:${GITHUB_REF};

Contributing

First off, thanks for taking the time to contribute! ❤️ See CONTRIBUTING.md for more information.

Contact

If you would like to send comments such as "find a bug" or "request for additional features" to the developer, please use one of the following contacts.

GitHub Issue

LICENSE

The contributor project is licensed under the terms of MIT LICENSE.

nao1215 / contributor