Skip to content

Rename package from rum_sdk to faro#38

Merged
robert-northmind merged 9 commits intomainfrom
feature/rename_to_faro
Mar 6, 2025
Merged

Rename package from rum_sdk to faro#38
robert-northmind merged 9 commits intomainfrom
feature/rename_to_faro

Conversation

@robert-northmind
Copy link
Copy Markdown
Collaborator

@robert-northmind robert-northmind commented Mar 6, 2025

This PR renames the package from rum_sdk to faro to align with Grafana's branding.
The main changes include:

  • Renamed the main package directory from rum_sdk to faro
  • Updated all imports and references to use the new package name
  • Updated file paths and class names to reflect the new branding
  • Adjusted documentation to reference the new package name

This change addresses GitHub issue #3 which requested renaming the package to a Faro branded name.

This commit introduces two new Cursor rule files to enhance project organization and development workflow:

- Added `.cursor/rules/cursor-rules-location.mdc` to define standards for placing Cursor rule files
- Added `.cursor/rules/plan-it-mode.mdc` to implement a structured approach for task planning and execution

Key improvements:
- Establishes clear guidelines for rule file placement
- Introduces a systematic planning process for complex tasks
- Promotes better project documentation and task tracking
@robert-northmind robert-northmind added documentation Improvements or additions to documentation enhancement New feature or request labels Mar 6, 2025
This commit updates documentation across multiple files to:
- Rename references from 'RUM' to 'Faro'
- Update class and method names to use 'Faro' prefix
- Align documentation with the recent package renaming
- Add a new project overview markdown file
- Update links and configuration examples
@robert-northmind robert-northmind force-pushed the feature/rename_to_faro branch from e84c86b to ac0ed93 Compare March 6, 2025 13:56
This commit removes an unnecessary commented-out line of code related to the previous RUM SDK initialization, cleaning up the example app's main file and reflecting the recent Faro SDK renaming.
Simplifies the verification of app startup measurement push in the native integration test by removing unnecessary whitespace and ensuring clean, concise test assertion.
Removes the package_api_docs linter rule from the analysis_options.yaml configuration to streamline code analysis and reduce unnecessary documentation warnings.
- Restore .gitkeep file in packages/faro/example/assets/ to preserve directory structure
- Upgrade actions/checkout GitHub Action from v3 to v4
- Remove previous global exclusion of example/assets/ from .gitignore
Update the actions/checkout GitHub Action from version 3 to version 4 in the flutter_checks.yml workflow file to leverage the latest features and improvements.
@robert-northmind robert-northmind merged commit 9bfa9c2 into main Mar 6, 2025
3 checks passed
@robert-northmind robert-northmind deleted the feature/rename_to_faro branch March 6, 2025 14:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant