all-contributors / all-contributors/cli

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

Đang mở
#369 0 bình luận 0 reaction 0 người được giao Xem trên GitHub
type: bug
Ngôn ngữ chính
JavaScript
Star
425
Fork
149
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Mô tả

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

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Đánh giá

Issue này chưa được đánh giá.

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.