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

docs: show complete list of commitConventions #699

Merged
merged 2 commits into from
May 12, 2023
Merged

docs: show complete list of commitConventions #699

merged 2 commits into from
May 12, 2023

Conversation

EndBug
Copy link
Contributor

@EndBug EndBug commented Mar 24, 2023

What:
This PR adds none to the valid commitConventions values in docs.

Why:
Some users have this option from the previous versions of the docs, and are now wondering whether the none option is still valid (see #685)
none is valid since it's supported by commit-conv, the package you're using.

How:
I just added it to the list in the "Bot configuration" page. Also applies to CLI, which currently doesn't have its own page.

Checklist:

  • Documentation
  • Ready to be merged
  • Added myself to contributors table.
    Bot Usage

As someone has pointed out in #685, `"none"` is a valid value for the
`commitConventions` configuration option (since it's supported by the
`commit-conv` package, and the app doesn't perform any additional check
on it).
@EndBug EndBug requested a review from a team as a code owner March 24, 2023 15:43
Copy link

@gr2m gr2m left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@gr2m gr2m merged commit 808868e into all-contributors:master May 12, 2023
@EndBug EndBug deleted the commit-conventions branch May 12, 2023 23:16
@all-contributors-release-bot
Copy link
Member

🎉 This PR is included in version 2.17.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

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

Successfully merging this pull request may close these issues.

None yet

3 participants