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

bug: semantic PR check in CI not documented in CONTRIBUTING #12

Open
lucasgonze opened this issue Jul 13, 2023 · 0 comments
Open

bug: semantic PR check in CI not documented in CONTRIBUTING #12

lucasgonze opened this issue Jul 13, 2023 · 0 comments

Comments

@lucasgonze
Copy link
Contributor

Description

On submitting a PR that matches the requirements in CONTRIBUTING.md, the submitter will get a failure based on the formatting of their commit message, but the formatting is not documented.

Current behavior

CI error on PR:

=== developer-toolkit-template-go === [ lint-commit      ]: Checking that commit messages are properly formatted...
f3551e1: subject does not match regex [(chore|docs|feat|fix|refactor|tests?)\s?(\([^\)]+\))?!?: .*]
make: *** [build/lint.mk:53: lint-commit] Error 1

Expected behavior

The contributor guidelines should communicate that subject must begin with a keyword followed by a colon.

Steps To Reproduce

Steps to reproduce the behavior:

  1. Create a commit with message "Debug"
  2. Submit PR
  3. See error relating to commit formatting

Debug Output (if applicable)

image

Additional Context

https://github.com/newrelic/developer-toolkit-template-go/actions/runs/5546108613/jobs/10125939014?pr=11

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

No branches or pull requests

1 participant