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

Missing documentation for commitType configuration #710

Open
brandonlenz opened this issue Jun 6, 2023 · 3 comments · May be fixed by #757
Open

Missing documentation for commitType configuration #710

brandonlenz opened this issue Jun 6, 2023 · 3 comments · May be fixed by #757
Labels
bug Something isn't working

Comments

@brandonlenz
Copy link

brandonlenz commented Jun 6, 2023

Describe the bug
A recent all-contributors PR automatically added an autoconfiguration for commitType, but at the time of writing it is not noted as a possible configuration in the official docs

To Reproduce
Steps to reproduce the behavior:

  1. Use the all contributors bot to open a PR on a repo (might be relevant that the configuration specifies angular as the commitConvention)
  2. Note that commitType is updated to a default of docs in this commit by AC bot

Expected behavior
Documentation should list commitType description and accepted options/values (or link to them if pulling from conventional commits spec)

Anything else?

Relevant PR adding the change to the bot: all-contributors/app#462

It is specifically noted in the PR body that due to lack of documentation on commitConvention, docs for commitType were skipped as well. There are, however, docs for commitConvention here, so there should be docs for commitType as well

@brandonlenz
Copy link
Author

cc: @tobiasbueschel

@bressler1995
Copy link

I also have to second this. I am going to be merging from a fork to another repository, and this commitType variable was added automatically to the configuration. It would be good to have some documentation on this since it is not exactly known what behavior this may result in. Hopefully it's something insignificant.

danieltott added a commit to danieltott/all-contributors that referenced this issue Oct 31, 2023
Add the commitType key and description to the configuration table

✅ Closes: all-contributors#710
@danieltott danieltott linked a pull request Oct 31, 2023 that will close this issue
3 tasks
@danieltott
Copy link

Got a PR up for this here: #757

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants