Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
attilarepka committed Dec 16, 2024
1 parent 07a9ae0 commit 1607ed0
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 11 deletions.
17 changes: 10 additions & 7 deletions .github/workflows/pr.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
name: check pr title

on:
pull_request:
types: [opened, edited]
pull_request:

steps:
- uses: Slashgear/[email protected]
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/[email protected]
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/"
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)

Expand All @@ -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

Expand Down Expand Up @@ -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

Expand Down

0 comments on commit 1607ed0

Please sign in to comment.