{"id":15651381,"url":"https://github.com/bobankh/add-contributors","last_synced_at":"2025-08-13T18:09:14.106Z","repository":{"id":38259854,"uuid":"282634917","full_name":"BobAnkh/add-contributors","owner":"BobAnkh","description":"A  Github Action to add contributors to your file automatically. Feel free to contribute!","archived":false,"fork":false,"pushed_at":"2023-02-20T06:56:45.000Z","size":146,"stargazers_count":39,"open_issues_count":3,"forks_count":20,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-07-18T14:25:21.678Z","etag":null,"topics":["continuous-integration","contributions-welcome","dockerfile","github-actions","github-api","python","utilities"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/auto-add-contributors","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/BobAnkh.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-07-26T11:23:45.000Z","updated_at":"2025-03-21T19:15:37.000Z","dependencies_parsed_at":"2024-06-18T13:56:03.970Z","dependency_job_id":"77f5b861-8f99-430a-85a2-69d71e2b7beb","html_url":"https://github.com/BobAnkh/add-contributors","commit_stats":{"total_commits":151,"total_committers":6,"mean_commits":"25.166666666666668","dds":"0.35761589403973515","last_synced_commit":"8bd02ce413bee09225ff2f27791ecb78ea273743"},"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"purl":"pkg:github/BobAnkh/add-contributors","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BobAnkh%2Fadd-contributors","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BobAnkh%2Fadd-contributors/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BobAnkh%2Fadd-contributors/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BobAnkh%2Fadd-contributors/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/BobAnkh","download_url":"https://codeload.github.com/BobAnkh/add-contributors/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BobAnkh%2Fadd-contributors/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270287051,"owners_count":24558615,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-13T02:00:09.904Z","response_time":66,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["continuous-integration","contributions-welcome","dockerfile","github-actions","github-api","python","utilities"],"created_at":"2024-10-03T12:38:09.848Z","updated_at":"2025-08-13T18:09:14.043Z","avatar_url":"https://github.com/BobAnkh.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# add-contributors\n\n[![Codacy Badge](https://api.codacy.com/project/badge/Grade/b8d0af034c5c4699805c6aca898787e7)](https://app.codacy.com/manual/bobankhshen/add-contributors?utm_source=github.com\u0026utm_medium=referral\u0026utm_content=BobAnkh/add-contributors\u0026utm_campaign=Badge_Grade_Dashboard)\n![GitHub release (latest by date)](https://img.shields.io/github/v/release/BobAnkh/add-contributors?color=orange\u0026logo=github-actions)\n![language-python](https://img.shields.io/github/languages/top/BobAnkh/add-contributors?logo=python\u0026logoColor=yellow)\n![LICENSE Apache-2.0](https://img.shields.io/github/license/BobAnkh/add-contributors?logo=apache)\n\nA Github Action to add contributors to your markdown file(i.e. README.md) automatically on schedule or triggered by events\n\nSpecifically handle unreachable Chinese context (着重解决了中文内容乱码的问题)\n\nFeel free to submit a pull request or an issue, but make sure to follow the templates\n\nWelcome contributors to improve this project together!\n\n## Usage\n\nCreate a workflow file such as `.github/workflows/contributors.yml` (you can find it in this repo)\n\n```yaml\nname: Add contributors\non:\n  schedule:\n    - cron:  '20 20 * * *'\n# push:\n#   branches:\n#     - master\n\njobs:\n  add-contributors:\n    runs-on: ubuntu-latest\n    steps:\n    - uses: actions/checkout@v2\n    - uses: BobAnkh/add-contributors@master\n      with:\n        CONTRIBUTOR: '### Contributors'\n        COLUMN_PER_ROW: '6'\n        ACCESS_TOKEN: ${{secrets.GITHUB_TOKEN}}\n        IMG_WIDTH: '100'\n        FONT_SIZE: '14'\n        PATH: '/README.md'\n        COMMIT_MESSAGE: 'docs(README): update contributors'\n        AVATAR_SHAPE: 'round'\n```\n\n### Parameters\n\n| Parameter            | Description                                                 | Required | Default                                            |\n| -------------------- | ----------------------------------------------------------- | -------- | -------------------------------------------------- |\n| REPO_NAME            | Repository name                                             | no       | `''` which means current repository                |\n| CONTRIBUTOR          | Where you want to add contributors list                     | no       | `### Contributors`                                 |\n| COLUMN_PER_ROW       | Number of contributors per row                              | no       | `6`                                                |\n| ACCESS_TOKEN         | Github Access Token                                         | yes      | You can just pass `${{secrets.GITHUB_TOKEN}}`      |\n| IMG_WIDTH            | Width of img                                                | no       | `100`                                              |\n| FONT_SIZE            | Font size of name (px)                                      | no       | `14`                                               |\n| PATH                 | Path to the file you want to add contributors' list         | no       | `/README.md`                                       |\n| BRANCH               | The branch to update file specified in PATH                 | no       | `''` which means default branch                    |\n| PULL_REQUEST         | Open a new pull request if set to a target branch name      | no       | `''` which means not open pull request by default  |\n| COMMIT_MESSAGE       | commit message                                              | no       | `docs(README): update contributors`                |\n| AVATAR_SHAPE         | Set `round` for round avatar and `square` for square avatar | no       | square                                             |\n| IGNORED_CONTRIBUTORS | Ignored contributors, seperated by comma                    | no       | `''`                                               |\n\n\u003e NOTE: You should leave a blank line after the `CONTRIBUTOR` line for the first time\n\u003e\n\u003e NOTE: Github seems not support image style in markdown file rendering yet\n\u003e\n\u003e NOTE: `IGNORED_CONTRIBUTORS` takes **display name** not **username**\n\u003e \n\u003e NOTE: `PULL_REQUEST` must be used with `BRANCH` together, both **should be provided** if you want to **open a pull request**\n\n## Maintainer\n\n[@BobAnkh](https://github.com/BobAnkh)\n\n## How to contribute\n\nYou should follow our [Code of Conduct](/CODE_OF_CONDUCT.md).\n\nSee [CONTRIBUTING GUIDELINES](/CONTRIBUTING.md) for contributing conventions.\n\nMake sure to pass all the tests before submitting your code. You can conduct `pytest -ra` at the root directory to run all tests.\n\nYou can use local mode when develope it on your local machine, here is the command-line help info:\n\n```console\nusage: main.py [-h] [-m MODE] [-f FILE] [-o OUTPUT] [-t TOKEN]\n\noptional arguments:\n  -h, --help            show this help message and exit\n  -m MODE, --mode MODE  choose to use local-dev mode or on github action mode.\n                        Valid values are 'local' or 'github'\n  -f FILE, --file FILE  configuration file to read from when running local-dev\n                        mode\n  -o OUTPUT, --output OUTPUT\n                        output file when running local-dev mode\n  -t TOKEN, --token TOKEN\n                        Github Access Token\n```\n\n### Contributors\n\n\u003ctable\u003e\n\u003ctr\u003e\n    \u003ctd align=\"center\" style=\"word-wrap: break-word; width: 150.0; height: 150.0\"\u003e\n        \u003ca href=https://github.com/BobAnkh\u003e\n            \u003cimg src=https://avatars.githubusercontent.com/u/44333669?v=4 width=\"100;\"  style=\"border-radius:50%;align-items:center;justify-content:center;overflow:hidden;padding-top:10px\" alt=Yixin Shen/\u003e\n            \u003cbr /\u003e\n            \u003csub style=\"font-size:14px\"\u003e\u003cb\u003eYixin Shen\u003c/b\u003e\u003c/sub\u003e\n        \u003c/a\u003e\n    \u003c/td\u003e\n    \u003ctd align=\"center\" style=\"word-wrap: break-word; width: 150.0; height: 150.0\"\u003e\n        \u003ca href=https://github.com/baileythegreen\u003e\n            \u003cimg src=https://avatars.githubusercontent.com/u/12277715?v=4 width=\"100;\"  style=\"border-radius:50%;align-items:center;justify-content:center;overflow:hidden;padding-top:10px\" alt=Bailey Harrington/\u003e\n            \u003cbr /\u003e\n            \u003csub style=\"font-size:14px\"\u003e\u003cb\u003eBailey Harrington\u003c/b\u003e\u003c/sub\u003e\n        \u003c/a\u003e\n    \u003c/td\u003e\n    \u003ctd align=\"center\" style=\"word-wrap: break-word; width: 150.0; height: 150.0\"\u003e\n        \u003ca href=https://github.com/casperklein\u003e\n            \u003cimg src=https://avatars.githubusercontent.com/u/590174?v=4 width=\"100;\"  style=\"border-radius:50%;align-items:center;justify-content:center;overflow:hidden;padding-top:10px\" alt=Casper/\u003e\n            \u003cbr /\u003e\n            \u003csub style=\"font-size:14px\"\u003e\u003cb\u003eCasper\u003c/b\u003e\u003c/sub\u003e\n        \u003c/a\u003e\n    \u003c/td\u003e\n\u003c/tr\u003e\n\u003c/table\u003e\n\n## LICENSE\n\n[Apache-2.0](/LICENSE) © BobAnkh\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbobankh%2Fadd-contributors","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbobankh%2Fadd-contributors","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbobankh%2Fadd-contributors/lists"}