Skip to content

Quick Start

Jump to bottom Edit New page
Josh Soref edited this page Feb 25, 2024 · 9 revisions

Quick Start

Instructions

  1. Clone the https://github.com/check-spelling/spell-check-this/ template repository
  2. Copy the contents of .github/ into your repository
  3. git add .github/
  4. git commit
  5. git push

Notes

This will give you handling for push, pull_request_target, and example files with a README.md describing the files and linking to more examples in this wiki.

  • If you have existing forks, you should see Onboarding for information about tweaks you can make to the workflow in order to improve the experience for PRs from those existing forks.

  • Best-practice for workflows is to use a pinned version.

  • There is generally a prerelease branch with evolving features, but you should not use it unless you need a specific feature from it.

  • You can configure GitHub's dependabot to receive notifications about updates to your workflow(s).

ℹ️ In general, a file task.ext can be replaced with a directory task/ containing multiple files ending with .ext if you prefer -- the files will be merged together.

FAQ | Showcase | Event descriptions | Configuration information | Known Issues | Possible features | Deprecations | Release notes | Helpful scripts

Add a custom sidebar
Clone this wiki locally