Tool to help automate adding contributor acknowledgements according to the all-contributors specification
Find a file
Darek Kay d517440203
feat: display a meaningful error when the config file is missing (#288)
* feat: display a meaningful error when the config file is missing

## What

When you try to add a user with `.all-contributorsrc` missing, you will get a cryptic error message (see also all-contributors/all-contributors#378):

```
$ all-contributors add darekkay maintenance
Cannot read property 'then' of null
```

This PR displays a meaningful error message in this case.

## Why

So users know what's causing the problem.

## How

Before a contribution is being added, the script checks whether the config file exists. If it doesn't, an error message is being displayed:

```
$ all-contributors add darekkay maintenance
Configuration file not found: C:\projects\test\.all-contributorsrc
```

* docs: add darekkay as a contributor

* refactor: fixed typos

* docs(readme): table rectification

Co-authored-by: Maximilian Berkmann <maxieberkmann@gmail.com>
2020-10-04 21:44:02 +01:00
.circleci feat(contribution-types): added "Data" contribution (#231) 2020-01-03 22:22:24 +00: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 feat: display a meaningful error when the config file is missing (#288) 2020-10-04 21:44:02 +01:00
.all-contributorsrc feat: display a meaningful error when the config file is missing (#288) 2020-10-04 21:44:02 +01: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 fix: fix badge replacement (#232) 2019-12-08 20:05:05 -05:00
.nvmrc feat(contribution-types): added "Data" contribution (#231) 2020-01-03 22:22:24 +00:00
.yvmrc feat(contribution-types): added "Data" contribution (#231) 2020-01-03 22:22:24 +00:00
jest.config.js ci: fix build runner, ensure jest exits when finished (#125) 2018-12-28 23:57:08 -07:00
LICENSE.md docs(license): MIT (#255) 2020-04-12 10:26:03 -07:00
package.json refactor: move from "request" to "node fetch" (#277) 2020-08-14 10:21:34 +01:00
prettier.config.js chore: upgrade and migrate tooling stuff (#73) 2017-11-22 11:09:06 -07:00
README.md feat: display a meaningful error when the config file is missing (#288) 2020-10-04 21:44:02 +01:00

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


Read this documentation in the following languages
한국어 中文 Bahasa Indonesia Deutsch Polski
English Português Español Français Русский 日本語

Build Status Code Coverage Version Downloads AUR Version All Contributors Star on Github

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 allcontributors.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

🎨

ehmicky

💻

James George

💻

Nick Schonning

💻

Cezar Augusto

📖

Jeppe Reinhold

💻

Rachel M. Carmena

💻

simon3000

⚠️

SnO₂WMaN

💻

Fabrizio

🐛 💻

kharaone

💻

Marcelo Alves

💻 ⚠️

Anand Chowdhary

⚠️ 🐛 💻

Nicolas Goutay

💻

Tyler Krupicka

💻 ⚠️

Stefano Moia

💻

Ilaï Deutel

📦

Justin Dalrymple

💻

Piotr Stępniewski

🐛 💻 ⚠️

Gregor Martynus

👀 💬

Jeff Wen

👀

Paweł Kowalski

💻

Markus Löning

💻

David Anson

🐛

Jeroen Claassens

💻

Shai Reznik

🐛 💻 ⚠️

Darek Kay

💻

Erek Speed

💻

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

LICENSE

MIT