mirror of https://github.com/all-contributors/cli.git synced 2025-01-09 13:36:29 +00:00

Tool to help automate adding contributor acknowledgements according to the all-contributors specification ✨

acknowledgements all-contributors command-line-tool contributors open-source-tooling opensource opensource-management recognition

Find a file

Maximilian Berkmann b0c3376ac4 BREAKING CHANGE: changed generator to an HTML based one (#157 ) BREAKING CHANGE * style(generate): changed generator to an HTML based one [WIP] I added and set the HTML generator for resolving #154 (which works when testing manually but doesn't when running the cli in dev mode). fix #154 * refactor(generate): (re)moved files to keep it DRY * refactor: refactored/updated tests Update the contributors test (which wasn't already committed somehow) and tweaked the `format-contribution-type` test. * docs(readme): removed doctoc BREAKING CHANGE: (in `2babe26b08`) The resulting contributors table is in HTML/CSS instead of being in Markdown. * refactor(generate): removed the style from the generation Removed the `<style>` block from the generated HTML code as it's redundant on Github (since it's one of the non-whitelisted tags). The `README.md` was also updated reflecting the breaking changes. * refactor(generate): image height and tweaks Added `height` to images for avatars, quoted some `<table>` attributes and updated `README.md` * docs: drop TOC		2019-02-06 08:37:09 -10:00
.circleci	infra: bump cache to get latest deps (#151 )	2019-01-18 13:36:37 -05:00
.github	chore: upgrade and migrate tooling stuff (#73 )	2017-11-22 11:09:06 -07:00
other	chore: upgrade and migrate tooling stuff (#73 )	2017-11-22 11:09:06 -07:00
src	BREAKING CHANGE: changed generator to an HTML based one (#157 )	2019-02-06 08:37:09 -10:00
.all-contributorsrc	docs: add tbenning as a contributor (#140 )	2019-01-15 00:37:17 +08:00
.codecov.yml	infra: add .codecov.yml	2019-01-21 21:00:16 -05:00
.eslintrc.js	infra: fix lint (#150 )	2019-01-18 13:32:13 -05:00
.gitignore	chore: upgrade and migrate tooling stuff (#73 )	2017-11-22 11:09:06 -07:00
.nvmrc	fix: switch over to new org all-contributors (#132 )	2019-01-07 15:55:57 +08:00
.yvmrc	fix: switch over to new org all-contributors (#132 )	2019-01-07 15:55:57 +08:00
jest.config.js	ci: fix build runner, ensure jest exits when finished (#125 )	2018-12-28 23:57:08 -07:00
package.json	BREAKING CHANGE: changed generator to an HTML based one (#157 )	2019-02-06 08:37:09 -10:00
prettier.config.js	chore: upgrade and migrate tooling stuff (#73 )	2017-11-22 11:09:06 -07:00
README.md	BREAKING CHANGE: changed generator to an HTML based one (#157 )	2019-02-06 08:37:09 -10:00

README.md

There is now a GitHub Bot for automating the maintenance of your contributors table ✨
Say goodbye to command line tool dependencies and hello to the @all-contributors bot 🤖

all-contributors-cli

Automate acknowledging contributors to your open source projects

The problem

You want to implement the All Contributors spec, but don't want to maintain the table by hand

This solution

This is a tool to help automate adding contributor acknowledgements according to the all-contributors specification for your GitHub or GitLab repository.

Using the all-contributors-cli

If you're looking to use the cli, head over to the cli docs on all-contributors.js.org. The all-contributors website contains all the information required to install, configure and use the all-contributors-cli.

Contributors

Thanks goes to these wonderful people (emoji key):

_{Jeroen Engels} 💻 📖 ⚠️	_{Kent C. Dodds} 📖 💻	_{João Guimarães} 💻	_{Ben Briggs} 💻	_{Itai Steinherz} 📖 💻	_{Alex Jover} 💻 📖
_{Jerod Santo} 💻	_{Kevin Jalbert} 💻	_tunnckoCore 🔧	_{Mehdi Achour} 💻	_{Roy Revelt} 🐛	_{Chris Vickery} 💻
_{Bryce Reynolds} 💻	_{James, please} 🤔 💻	_{Spyros Ioakeimidis} 💻	_{Fernando Costa} 💻	_snipe 📖	_{Gant Laborde} 💻
_{Md Zubair Ahmed} 📖 🐛 💻 ⚠️	_{Divjot Singh} 📖	_{João Marques} 💻 📖 🤔	_{Andrew Lisowski} 💻 📖 ⚠️	_{Xianming Zhong} 📖	_C.Y.Xu 💻
_Dura 📖	_{Jake Bolam} 🚇 💻 📖 ⚠️	_{Maximilian Berkmann} 💻 ⚠️ 📖	_tbenning 🎨

This project follows the all-contributors specification. Contributions of any kind are welcome!

LICENSE

MIT