Skip to content

Update README#192

Merged
Kitenite merged 3 commits intomainfrom
readme-update
Nov 30, 2025
Merged

Update README#192
Kitenite merged 3 commits intomainfrom
readme-update

Conversation

@Kitenite
Copy link
Copy Markdown
Collaborator

@Kitenite Kitenite commented Nov 30, 2025

  • update README
  • add more docs

Description

Related Issues

Type of Change

  • Bug fix
  • New feature
  • Documentation
  • Refactor
  • Other (please describe):

Testing

Screenshots (if applicable)

Additional Notes

Summary by CodeRabbit

  • Documentation

    • Added a Code of Conduct and expanded CONTRIBUTING with contribution workflow and PR guidance.
    • Overhauled README content, Getting Started flow, usage media, and tech stack/badges.
  • Chores

    • Removed deprecated port-management script.
    • Simplified dev/build scripts and added a desktop-focused build/dev entry.
    • Stopped exposing a legacy UI feature flag in the desktop build/type info and adjusted desktop build invocation.

✏️ Tip: You can customize this high-level summary in your review settings.

@vercel
Copy link
Copy Markdown

vercel Bot commented Nov 30, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
website Ready Ready Preview Comment Nov 30, 2025 10:03pm

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Nov 30, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

The PR adds a CODE_OF_CONDUCT, replaces CONTRIBUTING placeholder with full contribution guidance, substantially updates README content and badges, removes ENABLE_NEW_UI from desktop Vite config and TypeScript env, adjusts npm scripts for desktop-focused dev/build, and deletes the deprecated update-port.sh script.

Changes

Cohort / File(s) Summary
Documentation
CODE_OF_CONDUCT.md, CONTRIBUTING.md, README.md
Added Contributor Covenant 2.0 code of conduct; expanded CONTRIBUTING.md with contribution workflow and style guidelines; overhauled README messaging, getting-started steps, usage videos/images, and tech stack badges.
Desktop configuration & types
apps/desktop/electron.vite.config.ts, apps/desktop/index.d.ts
Removed injection/definition of ENABLE_NEW_UI from renderer build defines and removed ENABLE_NEW_UI from the ImportMetaEnv interface.
Desktop build script
apps/desktop/package.json
Prepended CSC_IDENTITY_AUTO_DISCOVERY=false via cross-env to the desktop build script invocation.
Monorepo scripts
package.json
Changed dev to turbo dev --filter=@superset/desktop; added dev:all (unfiltered) and a build script filtered to @superset/desktop; removed the prior dev:desktop and previous broad build filter.
Deprecated tooling removal
update-port.sh
Deleted deprecated port-management script and its deprecation messaging.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

  • Check for any occurrences of import.meta.env.ENABLE_NEW_UI across renderer code and tests.
  • Validate the new npm script filters and the added cross-env CSC_IDENTITY_AUTO_DISCOVERY=false flag behave as intended on CI and developer machines.
  • Skim documentation links and usage steps for accuracy vs. current repo layout (worktree/setup.json references).

Possibly related PRs

  • Update README #192 — Directly overlaps these changes (docs, desktop env/tidy, scripts, and update-port.sh deletion).
  • refactor 1 #69 — Removes the same ENABLE_NEW_UI env/type definitions in desktop renderer.
  • update README #141 — Overlaps README and other documentation content updates.

Poem

🐇 I hopped through files with curious eyes,
Penned a code of conduct under moonlit skies.
Docs refreshed, old scripts set free,
Desktop flags trimmed from the tree.
A tiny carrot of clarity for thee 🥕

Pre-merge checks and finishing touches

❌ Failed checks (1 warning, 1 inconclusive)
Check name Status Explanation Resolution
Description check ⚠️ Warning The PR description contains only placeholder text and vague bullet points ('update README', 'add more docs') without filling in any required template sections, making it impossible to understand the actual changes. Complete all template sections: provide a detailed description of changes, check the Type of Change checkboxes, and explain testing/verification performed.
Title check ❓ Inconclusive The title 'Update README' is vague and overly generic, failing to convey the full scope of changes which include updating multiple documentation files, build configurations, and package scripts. Use a more descriptive title that captures the main objectives, such as 'Update documentation and development setup' or 'Refactor build configuration and update docs'.
✅ Passed checks (1 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

📜 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 9251001 and cc0c194.

⛔ Files ignored due to path filters (3)
  • assets/create-tabs.mp4 is excluded by !**/*.mp4
  • assets/create-worktree.mp4 is excluded by !**/*.mp4
  • assets/notifs.png is excluded by !**/*.png
📒 Files selected for processing (1)
  • README.md (5 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

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
CODE_OF_CONDUCT.md (1)

63-63: Personal email for code-of-conduct enforcement contact may present long-term maintenance concerns.

The enforcement contact is listed as a personal email address (hoakiet98@gmail.com). While this is common in early-stage projects, consider whether:

  1. A shared team email or GitHub Discussions/Issues should be used instead for scalability and bus-factor resilience.
  2. A rotation or escalation policy exists if the primary contact becomes unavailable.

For a young project, this is acceptable, but plan for an organizational contact as the project grows.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between efad18a and 9251001.

📒 Files selected for processing (8)
  • CODE_OF_CONDUCT.md (1 hunks)
  • CONTRIBUTING.md (1 hunks)
  • README.md (6 hunks)
  • apps/desktop/electron.vite.config.ts (0 hunks)
  • apps/desktop/index.d.ts (0 hunks)
  • apps/desktop/package.json (1 hunks)
  • package.json (1 hunks)
  • update-port.sh (0 hunks)
💤 Files with no reviewable changes (3)
  • apps/desktop/index.d.ts
  • update-port.sh
  • apps/desktop/electron.vite.config.ts
🧰 Additional context used
🧠 Learnings (3)
📚 Learning: 2025-11-28T01:03:47.951Z
Learnt from: CR
Repo: superset-sh/superset PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-11-28T01:03:47.951Z
Learning: Applies to apps/desktop/electron.vite.config.ts : Load `.env` file with `override: true` in Vite configuration for build-time environment variable access

Applied to files:

  • apps/desktop/package.json
📚 Learning: 2025-11-28T01:03:47.951Z
Learnt from: CR
Repo: superset-sh/superset PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-11-28T01:03:47.951Z
Learning: Use Bun as the package manager - no npm, yarn, or pnpm

Applied to files:

  • apps/desktop/package.json
📚 Learning: 2025-11-28T01:03:47.951Z
Learnt from: CR
Repo: superset-sh/superset PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-11-28T01:03:47.951Z
Learning: Use Turborepo as the build system for managing the monorepo

Applied to files:

  • package.json
🪛 LanguageTool
CONTRIBUTING.md

[style] ~17-~17: Consider using a different verb to strengthen your wording.
Context: ...rs to update your PR if necessary which speeds up the review process. [See more here](htt...

(SPEED_UP_ACCELERATE)

CODE_OF_CONDUCT.md

[style] ~32-~32: Try using a synonym here to strengthen your wording.
Context: ...ind * Trolling, insulting or derogatory comments, and personal or political attacks * Pu...

(COMMENT_REMARK)

README.md

[style] ~96-~96: Using many exclamation marks might seem excessive (in this case: 5 exclamation marks for a text that’s 2283 characters long)
Context: ...olor=black)](https://orm.drizzle.team/) [![Neon](https://img.shields.io/badge/Neon...

(EN_EXCESSIVE_EXCLAMATION)

🪛 markdownlint-cli2 (0.18.1)
CODE_OF_CONDUCT.md

38-38: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: Build
🔇 Additional comments (6)
apps/desktop/package.json (1)

23-23: Environment variable to skip code-signing is appropriate for development builds.

The CSC_IDENTITY_AUTO_DISCOVERY=false variable controls whether electron-builder attempts code-signing, enabling unsigned development builds. Combined with the new cross-env wrapper, this ensures cross-platform compatibility. This aligns with the README note that Superset Desktop is currently macOS-only and tested in development mode.

README.md (2)

33-60: Verify Getting Started instructions and duplicated install command.

The new Getting Started section provides helpful setup guidance, but has two issues:

  1. Line 49 duplicates bun install (already in line 44), likely a copy-paste error.
  2. The dev run command on line 50 uses bun run dev, which needs verification against the root package.json to ensure it aligns with the desktop-focused dev script changes (line 18: "dev": "turbo dev --filter=@superset/desktop").

Verify the Getting Started instructions against the repository's actual setup process. Confirm that:

  • The bun install duplication on line 49 should be removed
  • bun run dev correctly invokes the updated root-level dev script
  • The build output path apps/desktop/release is accurate

142-142: Verify LICENSE.txt exists at repository root.

The license URL reference changed from GitHub path to a relative local path ./LICENSE.txt. Confirm that the file exists in the repository root and is not named LICENSE.md instead.

package.json (1)

18-24: Strategic shift to desktop-focused defaults—confirm CI/CD alignment.

The package.json scripts have been reorganized to make desktop development the default (dev and build now filter for @superset/desktop), with dev:all as an escape hatch for full monorepo orchestration. This is a significant workflow change that requires verification:

  1. Confirm that CI/CD pipelines, pre-commit hooks, or automation scripts do not rely on the old dev:desktop or previous build behavior.
  2. Ensure documentation or team communication clarifies these new defaults, especially if other workspaces still need regular development.

Per learnings, Turborepo is the build system for this monorepo. The filtering syntax used is correct.

CONTRIBUTING.md (1)

1-27: Well-structured contributing guidelines with appropriate references.

The CONTRIBUTING.md provides clear, step-by-step guidance for contributors, including the fork-based PR workflow, maintainer edit permissions, and a concise style guide referencing the Boy Scout rule and Clean Code principles. The file appropriately cross-references the CODE_OF_CONDUCT.md and establishes a strong contribution culture.

A minor suggestion: Step 3 could clarify whether linking an issue is mandatory for all PRs or only for bug fixes/features.

CODE_OF_CONDUCT.md (1)

1-85: Comprehensive and industry-standard code of conduct.

The Contributor Covenant 2.0 provides a complete, well-structured framework for community standards, including clear definitions of acceptable and unacceptable behavior, well-defined enforcement responsibilities, and appropriate attribution. The scope, enforcement, and privacy protections are clearly articulated and align with best practices for open-source projects.

@Kitenite Kitenite merged commit c995855 into main Nov 30, 2025
6 of 7 checks passed
@Kitenite Kitenite deleted the readme-update branch November 30, 2025 22:04
This was referenced Nov 30, 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.

1 participant