https://github.com/codingjoe/word-weasel

Elevate your technical writing!
https://github.com/codingjoe/word-weasel

actions github-actions github-config workflow

Last synced: about 1 month ago
JSON representation

Elevate your technical writing!

• Host: GitHub
• URL: https://github.com/codingjoe/word-weasel
• Owner: codingjoe
• License: bsd-2-clause
• Created: 2025-12-22T15:49:54.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2026-01-05T10:04:05.000Z (3 months ago)
• Last Synced: 2026-01-11T15:17:28.502Z (2 months ago)
• Topics: actions, github-actions, github-config, workflow
• Homepage:
• Size: 9.77 KB
• Stars: 2
• Watchers: 0
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Word Weasel

**Write better PRs and commit messages.**

Word Weasel is a GitHub Action that helps you write better pull request titles and descriptions by analyzing them for clarity, conciseness, and overall quality.

It provides suggestions to improve your writing, ensuring that your PRs are easy to understand and review.

## Usage

```yaml

# .github/workflows/pull-rqeuest.yml

# Write better PRs and commit messages

name: "Word Weasel"

on:

  pull_request:

    types:

      - opened

      - edited

      - reopened

      # Optional, if you want to include the check in branch protection rules

      # - synchronize

jobs:

  pr-title:

    name: "PR Title"

    runs-on: ubuntu-latest

    timeout-minutes: 1

    if: ${{ github.actor != 'dependabot[bot]' }}

    steps:

      - uses: codingjoe/word-weasel@v1

        with:

          text: ${{ github.event.pull_request.title }}

  pr-body:

    name: "PR Body"

    runs-on: ubuntu-latest

    timeout-minutes: 1

    if: ${{ github.actor != 'dependabot[bot]' }}

    steps:

      - uses: codingjoe/word-weasel@v1

        with:

          text: ${{ github.event.pull_request.body }}

```