Adding ./checks.sh for contributors, and easier dev-tool setup

[scosman]

Summary by CodeRabbit

• Documentation

  • Enhanced the README with new sections on enabling GitHub Actions and running developer tools locally.
  • Added guidance on running developer tools from Git Hooks, emphasizing pre-commit checks.
  • Improved clarity and organization of existing documentation.

• New Features

  • Introduced a checks.sh script to automate quality assurance checks, including spell checking, formatting, linting, and testing.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The recent changes include enhancements to the README.md for improved documentation on developer tools and CI processes, alongside the introduction of a new checks.sh script. The documentation now clarifies enabling GitHub Actions, running developer tools locally, and emphasizes pre-commit checks. The checks.sh script automates quality assurance checks, including spell checking, formatting, linting, and testing, thereby streamlining the development workflow.

Changes

Files	Change Summary
README.md	Added sections on enabling GitHub Actions, running developer tools locally, and running tools from Git hooks. Reorganized existing content for clarity.
checks.sh	Introduced a script that automates quality assurance checks, including spell checking, formatting, linting, and testing.

Poem

🐰 In the meadow, tools now gleam,
With scripts and checks, we build our dream.
GitHub flows, like rivers wide,
In harmony, we take our stride.
Hopping forth with joy and cheer,
Quality code, we hold so dear! 🌼

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[cloudflare-workers-and-pages]

Deploying saasstarter with    Cloudflare Pages

Latest commit:	5c5da26
Status:	✅  Deploy successful!
Preview URL:	https://a8388a96.saasstarter.pages.dev
Branch Preview URL:	https://checks.saasstarter.pages.dev

View logs