Autofill the description of your pull requests with the power of OpenAI!

platisd/openai-pr-description is a GitHub Action that looks at the title as well as the contents of your pull request and uses the OpenAI API to automatically fill up the description of your pull request. Just like ChatGPT would! 🎉
The Action tries to focus on why the changes are needed rather on what they are, like any proper pull request description should.

The GitHub Action will only run when a PR description is not already provided. In other words it will not accidentally overwrite your existing description. The idea is this Action will save you the time and trouble of writing meaningful pull request descriptions.
You can customize it in different ways. One of them allows the Action to only run on pull requests started by specific users, e.g. the main maintainers of the repository. Keep in mind the OpenAI API is not free to use. That being said, so far it's been rather cheap, i.e. around ~$0.10 for 15-20 pull requests so far.

1. Create an account on OpenAI, set up a payment method and get your OpenAI API key.
2. Add the OpenAI API key as a secret in your repository's settings.
3. Create a workflow YAML file, e.g. .github/workflows/openai-pr-description.yml with the following contents:

name: Autofill PR description

on: pull_request

jobs:
  openai-pr-description:
    runs-on: ubuntu-22.04

    steps:
      - uses: platisd/openai-pr-description@master
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          openai_api_key: ${{ secrets.OPENAI_API_KEY }}

• platisd/smartcar_shield/pull/70
  • The GitHub Action explained why it is useful to add itself to a repository. 🤯

• platisd/cpp-command-parser/pull/16
  • A decent explanation on why fetching GoogleTest during the cmake build instead of version controlling it, is a good idea. 🎯

• platisd/clang-tidy-pr-comments/pull/43
  • I would improve it a bit, some parts are a bit off, but with small modifications it'd better than the PR description I originally had. 😅