diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml index 909c102..d03f34a 100644 --- a/.github/workflows/pr.yml +++ b/.github/workflows/pr.yml @@ -1,10 +1,13 @@ name: check pr title + on: -pull_request: -types: [opened, edited] + pull_request: -steps: - - uses: Slashgear/action-check-pr-title@v4.3.0 - with: - regexp: "(chore|docs|feat|fix|refactor|test): .++" # Regex the title should match. - helpMessage: "Example: 'feat: example of title'" +jobs: + check-pr-title: + runs-on: ubuntu-latest + steps: + - uses: Slashgear/action-check-pr-title@v4.3.0 + with: + regexp: "(?:build|ci|docs|feat|fix|perf|refactor|test)!?: [a-z]{1}.+[a-zA-Z0-9]{1}" + helpMessage: "Please use PR title being first line of a conventional commit, see https://www.conventionalcommits.org/en/v1.0.0/" diff --git a/README.md b/README.md index 30b6e14..b401e7e 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,6 @@ # header.nvim -**header.nvim is a Neovim plugin which adds or updates brief author information -and license headers to the top of the files.** +**A Neovim plugin to add or update author and license headers in your files.** [![Build status](https://github.com/attilarepka/header.nvim/actions/workflows/tests.yml/badge.svg)](https://github.com/attilarepka/header.nvim/actions) @@ -13,7 +12,7 @@ https://github.com/attilarepka/header.nvim/assets/39063661/2fa7f325-407a-42c1-9d - Add new copyright header - Update existing copyright header -- Add common licenses +- Add common licenses, see [here](#adding-licenses) ## Prerequisites @@ -132,7 +131,7 @@ autocmd("BufWritePre", { ## Contributing -Contributions are welcome! Open a GitHub issue or pull request. +Contributions are welcome! Open a GitHub [Issue](https://github.com/attilarepka/header.nvim/issues/new/choose) or [Pull request](https://github.com/attilarepka/header.nvim/pulls). ## License