Skip to content

Conversation

@jumski
Copy link
Contributor

@jumski jumski commented Nov 27, 2025

Update Flow and Step Naming Conventions to camelCase

This PR updates the naming conventions for flows and steps to use camelCase for slugs and kebab-case for file names. The changes include:

  1. Renamed example flow file from example_flow.ts to example-flow.ts
  2. Updated flow slugs from snake_case to camelCase (e.g., example_flowexampleFlow)
  3. Updated step slugs to follow camelCase convention
  4. Updated file paths in imports and tests to use kebab-case
  5. Added comprehensive naming convention documentation in /concepts/naming-conventions/
  6. Updated all code examples in documentation to follow the new conventions

These changes establish a consistent naming pattern across the codebase:

  • Flow slugs: camelCase (e.g., greetUser)
  • Step slugs: camelCase (e.g., fetchData)
  • File names: kebab-case (e.g., greet-user.ts)
  • Flow exports: PascalCase (e.g., GreetUser)
  • Worker directories: kebab-case + -worker (e.g., greet-user-worker/)

This standardization improves code readability and follows JavaScript ecosystem conventions.

@changeset-bot
Copy link

changeset-bot bot commented Nov 27, 2025

⚠️ No Changeset found

Latest commit: 48ca569

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

@chatgpt-codex-connector
Copy link

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.
To continue using code reviews, you can upgrade your account or add credits to your account and enable them for code reviews in your settings.

Copy link
Contributor Author

jumski commented Nov 27, 2025

Warning

This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
Learn more


How to use the Graphite Merge Queue

Add either label to this PR to merge it via the merge queue:

  • merge:queue - adds this PR to the back of the merge queue
  • hotfix:queue - for urgent hot fixes, skip the queue and merge this PR next

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

This stack of pull requests is managed by Graphite. Learn more about stacking.

@nx-cloud
Copy link

nx-cloud bot commented Nov 27, 2025

View your CI Pipeline Execution ↗ for commit 48ca569

Command Status Duration Result
nx affected -t verify-exports --base=origin/mai... ✅ Succeeded 5s View ↗
nx affected -t build --configuration=production... ✅ Succeeded 40s View ↗
nx affected -t lint typecheck test --parallel -... ✅ Succeeded 4m 19s View ↗
nx run edge-worker:e2e ✅ Succeeded 2m 53s View ↗
nx run cli:e2e ✅ Succeeded 7s View ↗

☁️ Nx Cloud last updated this comment at 2025-11-27 21:10:23 UTC

@github-actions
Copy link
Contributor

🔍 Preview Deployment: Website

Deployment successful!

🔗 Preview URL: https://pr-442.pgflow.pages.dev

📝 Details:

  • Branch: 11-27-unify_naming_conventions_and_install_example_flow
  • Commit: a66e2a5979cc49ebb9c9d9730e9ad5ba64f110f3
  • View Logs

_Last updated: _

@graphite-app
Copy link
Contributor

graphite-app bot commented Nov 28, 2025

Merge activity

  • Nov 28, 11:45 PM UTC: jumski added this pull request to the Graphite merge queue.
  • Nov 28, 11:45 PM UTC: CI is running for this pull request on a draft pull request (#449) due to your merge queue CI optimization settings.
  • Nov 28, 11:53 PM UTC: Merged by the Graphite merge queue via draft PR: #449.

graphite-app bot pushed a commit that referenced this pull request Nov 28, 2025
…se for files (#442)

# Update Flow and Step Naming Conventions to camelCase

This PR updates the naming conventions for flows and steps to use camelCase for slugs and kebab-case for file names. The changes include:

1. Renamed example flow file from `example_flow.ts` to `example-flow.ts`
2. Updated flow slugs from snake_case to camelCase (e.g., `example_flow` → `exampleFlow`)
3. Updated step slugs to follow camelCase convention
4. Updated file paths in imports and tests to use kebab-case
5. Added comprehensive naming convention documentation in `/concepts/naming-conventions/`
6. Updated all code examples in documentation to follow the new conventions

These changes establish a consistent naming pattern across the codebase:
- Flow slugs: camelCase (e.g., `greetUser`)
- Step slugs: camelCase (e.g., `fetchData`)
- File names: kebab-case (e.g., `greet-user.ts`)
- Flow exports: PascalCase (e.g., `GreetUser`)
- Worker directories: kebab-case + `-worker` (e.g., `greet-user-worker/`)

This standardization improves code readability and follows JavaScript ecosystem conventions.
@graphite-app graphite-app bot closed this Nov 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants