all-contributors / all-contributors/cli

Redundant commitConvention and repoType added to .all-contributorsrc file on add

Offen
#369 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
type: bug
Vorherrschende Sprache
JavaScript
Sterne
425
Forks
149
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

**Describe the bug**

`.all-contributorsrc` files shouldn't need to include `commitConvention` or `repoType` properties. They both have default values as documented on https://allcontributors.org/docs/en/bot/configuration:

* `commitConvention`: `"angular"`
* `repoType`: `"github"`

But, running `npx all-contributors-cli add ...` is adding `commitConvention` or `repoType` properties with their default values to `.all-contributorsrc` files that don't have them explicitly.

```diff
{
"contributors": [ ... ],
"projectName": "repros-example",
"projectOwner": "JoshuaKGoldberg",
+ "repoType": "github",
+ "commitConvention": "angular"
}
```

**To Reproduce**

See https://github.com/JoshuaKGoldberg/repros/tree/all-contributors-cli-add-field-defaults.

1. Create a repo with a minimal `.all-contributorsrc`
2. Run `npx all-contributors-cli add JoshuaKGoldberg doc`

**Expected behavior**

The `.all-contributorsrc` file shouldn't have `commitConvention` or `repoType` added, since they have documented defaults.

**Additional context**

I filed a bunch of feature requests over on https://github.com/all-contributors/all-contributors for more default-friendly behavior. https://github.com/all-contributors/all-contributors/issues/808 is something of a hub for them.

Beitragsleitfaden

Beitragsleitfaden öffnen

Bewertung

Dieses Issue wurde noch nicht bewertet.

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.