Contributing guide updates

[ericallam]

Summary by CodeRabbit

• Documentation
  • Updated development setup guides to streamline instructions for building the application and managing database migrations.
• New Features
  • Introduced new configuration options for database connectivity.

[changeset-bot]

⚠️ No Changeset found

Latest commit: e3c42d2

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request updates the development environment setup instructions in the CONTRIBUTING.md file by reordering steps, modifying commands to build both the CLI and packages with a specific filter, and adding explicit instructions for setting up Prisma and migrating the database. In addition, the .env.example file in the catalog directory now includes two new environment variable declarations for database connectivity.

Changes

File(s)	Change Summary
CONTRIBUTING.md	Revised setup instructions featuring reordering of steps, updated build command (including @trigger.dev/* filter), new step for changing directory, and consolidated Prisma migration commands.
references/v3-catalog/.env.example	Added declarations for two new environment variables: DATABASE_URL and DATABASE_URL_UNPOOLED, both set to PostgreSQL connection strings.

Sequence Diagram(s)

sequenceDiagram
  participant Developer
  participant CONTRIBUTING
  participant CatalogDir as <root>/refs/.../v3-catalog
  participant Database

  Developer->>CONTRIBUTING: Open setup instructions
  CONTRIBUTING-->>Developer: Display build & CLI instructions (with @trigger.dev/* filter)
  Developer->>CatalogDir: Navigate into references/v3-catalog
  CatalogDir-->>Developer: Provide Prisma setup and migration steps
  Developer->>Database: Execute migration commands
  Database-->>Developer: Confirm successful migration
  Developer->>CONTRIBUTING: Run 'dev' command and access dashboard

Loading

Suggested reviewers

• matt-aitken
• nicktrn

Poem

I'm just a rabbit with joyous delight,
Hopping through changes, coding day and night.
The build steps bloom like spring in the air,
Migrations run smoothly with care.
New env variables shine with a glimmer so bright,
Celebrating these updates with a happy, bunny flight!
🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between de4ee19 and e3c42d2.

📒 Files selected for processing (2)

• CONTRIBUTING.md (3 hunks)
• references/v3-catalog/.env.example (1 hunks)

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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>, please review it.
  • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @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 generate docstrings to generate docstrings for this 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.