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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

馃洜 Tooling: Unnecessary commitType: docs in .all-contributorsrc #1090

Open
3 tasks done
JoshuaKGoldberg opened this issue Dec 11, 2023 · 2 comments
Open
3 tasks done
Labels
area: tooling Managing the repository's maintenance status: accepting prs Please, send a pull request to resolve this! type: cleanup Tech debt or other code/repository cleanups

Comments

@JoshuaKGoldberg
Copy link
Owner

Bug Report Checklist

  • I have tried restarting my IDE and the issue persists.
  • I have pulled the latest main branch of the repository.
  • I have searched for related issues and found none that matched my issue.

Overview

Thanks to #1048, we see now that this repository has two bits of tooling that are different between its 馃崕 actual files and 馃崒 code templates (see Additional Info below for explanation of the emojis):

Docs for commitType are being added in all-contributors/all-contributors#710 -> all-contributors/all-contributors#757. Seems that the default value is "docs". So there's no need to explicitly specify it the way this repo has been.

Let's remove any and all references to commitType from this repo. Accepting PRs!

Additional Info

This repository is two things:

  • 馃崕 An example of a working TypeScript repository, including builds, Knip, package publishing, and more tooling
  • 馃崒 Code that can set up a new or existing repository using all of that repository tooling

For the most part, the repository's end-to-end test for --mode migration makes sure that the 馃崕 actual files and 馃崒 code templates stay the same. As in, if one changes, the other needs to have the same change as well. But per #546, there are some files that were missed in that test. We're only now able to verify that they're the same as of #1048. That PR is where this discrepancy was discovered.

@JoshuaKGoldberg JoshuaKGoldberg added good first issue Good for newcomers, please hop on! type: bug Something isn't working :( area: tooling Managing the repository's maintenance status: accepting prs Please, send a pull request to resolve this! type: cleanup Tech debt or other code/repository cleanups and removed type: bug Something isn't working :( labels Dec 11, 2023
@JoshuaKGoldberg
Copy link
Owner Author

Err, maybe "commitType": "docs" gets added automatically? See https://github.com/JoshuaKGoldberg/eslint-plugin-never-disable/pull/7/files#. Removing good first issue as this might involve some investigation...

@JoshuaKGoldberg JoshuaKGoldberg removed the good first issue Good for newcomers, please hop on! label Dec 11, 2023
@JoshuaKGoldberg JoshuaKGoldberg self-assigned this Dec 30, 2023
@JoshuaKGoldberg
Copy link
Owner Author

JoshuaKGoldberg commented Dec 30, 2023

Assigning to myself so I can test out the migration test improvements added in #1048. Never mind 馃檪

@JoshuaKGoldberg JoshuaKGoldberg removed their assignment Dec 30, 2023
JoshuaKGoldberg added a commit that referenced this issue Dec 30, 2023
## PR Checklist

- [x] Addresses an existing open issue: fixes #1086
- [x] That issue was marked as [`status: accepting
prs`](https://github.com/JoshuaKGoldberg/create-typescript-app/issues?q=is%3Aopen+is%3Aissue+label%3A%22status%3A+accepting+prs%22)
- [x] Steps in
[CONTRIBUTING.md](https://github.com/JoshuaKGoldberg/create-typescript-app/blob/main/.github/CONTRIBUTING.md)
were taken

## Overview

Corrects the emojis and indentation in the `badgeTemplate` property.

Also sets `commitType` manually per #1090 - leaving the issue open.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: tooling Managing the repository's maintenance status: accepting prs Please, send a pull request to resolve this! type: cleanup Tech debt or other code/repository cleanups
Projects
None yet
Development

No branches or pull requests

1 participant