Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
JoshuaKGoldberg opened this issue Dec 31, 2024 · 0 comments
Labels

Comments

@JoshuaKGoldberg
Copy link
Contributor

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.

 {
 	"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. all-contributors/all-contributors#808 is something of a hub for them.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant