How should I name my prompt files?

AutoCI can support a prompt creating multiple workflows and will always recommend a descriptive name for each workflow. However, if you are opinionated and want to name your workflows something specific, just specify the name of the workflow file in your prompt.

One common pattern is to name the workflow file after the event that will trigger it. This works well on most projects. For example, if you have a workflow that runs when a PR is opened, you could name the workflow file pr-opened.txt.

Discussion

While AutoCI is smart enough to suggest appropriate names for your workflows, there are times when you might want more control:

  • When you have established naming conventions in your organization
  • When you want to group related workflows together
  • When you want to make the purpose of the workflow immediately clear to other team members
← Back to Prompting Best Practices