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.

Sign up for GitHub

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

test: Resolve dummy issue #7

Closed
wants to merge 1 commit into from
Closed

test: Resolve dummy issue #7

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 1 addition & 55 deletions README.MD
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,55 +1 @@
# Conventional PR

Conventional PR is a simple GitHub Action that attempts to ease your burden in managing your GitHub-hosted projects by automatically moderating low-quality pull requests (PR).

A PR is considered to be low quality if it satisfies at least one of these criterion:

- Doesn't have a description on it (empty body).
- Doesn't attempt to solve an issue (reference an issue).
- Doesn't follow [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/) style

> You can disable checking on draft pull requests, [see below options](#Usage)

## Features

1. Automatically label and comment on low quality PRs.
2. Enforce rules to everyone, even on administrators.
3. (Optional) Automatically close low quality PRs.

> **Disclaimer**: This project is really new. If you want to suggest a new feature, just drop it to [issues section](https://github.com/Namchee/conventional-pr/issues) and label your request `feature request`.

## Usage

Simply add this action on one of your GitHub workflows job:

```yml
on: pull_request # Run these every new pull request

jobs:
hqprs:
runs-on: ubuntu-latest
steps:
- name: hqprs
uses: Namchee/conventional-pr@v(version)
with:
access_token: YOUR_GITHUB_ACCESS_TOKEN_HERE # required
close: true # Determine whether Conventional PR should automatically close low quality PRs or not (default: true)
template: "Some string here" # Comment template (default: See code)
strict: true # Force rules on everyone, including administrators (default: true)
label: 'Some label' # Label on low quality PRs (default: 'Invalid')
allowedTypes: 'a, b, c' # Allowed conventional commit types. Must be comma-separated string. Fill with empty to allow all types. (default: empty string)
allowedScopes: 'a, b, c' # Allowed conventional commit scopes. Must be comma-separated string. Fill with empty to allow all scopes. (default: empty string)
checkDraft: false # Determine whether PR check should also run on draft PRs (default: false)
```

Refer to [GitHub workflow syntax](https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-syntax-for-github-actions#about-yaml-syntax-for-workflows) for more advanced usage.

See the example [here](https://github.com/Namchee/conventional-pr/blob/master/.github/workflows/conventional-pr.yml)

## Caveats

- If the issues are linked manually and are not mentioned in the PR body, the PR is still considered to be invalid.

## License

This project is licensed under the [MIT License](./LICENSE)
Probably going to give you up this time :)