Skip to content

Conversation

@chirag-madlani
Copy link
Collaborator

This pull request introduces comprehensive developer documentation for the OpenMetadata UI codebase. It adds a dedicated developer handbook detailing folder structure, naming conventions, component and type organization, API and state management practices, styling guidelines (with LESS and MUI), icon usage, and testing standards. Additionally, the main README.md is updated to reference this handbook and provide onboarding instructions for new contributors.

Documentation improvements:

  • Added a new DEVELOPER_HANDBOOK.md file outlining folder structure, naming conventions, component and type patterns, API/state management, styling with LESS and MUI, icon usage with @untitledui/icons, and testing standards for the UI codebase.
  • Updated README.md to include a "Developer instructions" section, linking to the new handbook and summarizing key technologies and onboarding steps for new developers.

Describe your changes:

Fixes

I worked on ... because ...

Type of change:

  • Bug fix
  • Improvement
  • New feature
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation

Checklist:

  • I have read the CONTRIBUTING document.
  • My PR title is Fixes <issue-number>: <short explanation>
  • I have commented on my code, particularly in hard-to-understand areas.
  • For JSON Schema changes: I updated the migration scripts or explained why it is not needed.

@github-actions
Copy link
Contributor

github-actions bot commented Nov 18, 2025

Jest test Coverage

UI tests summary

Lines Statements Branches Functions
Coverage: 63%
63.43% (49461/77981) 40.5% (23646/58383) 44.29% (7494/16921)

@sonarqubecloud
Copy link

@chirag-madlani chirag-madlani merged commit b79a816 into main Nov 20, 2025
24 checks passed
@chirag-madlani chirag-madlani deleted the update-dev-handbook branch November 20, 2025 10:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

safe to test Add this label to run secure Github workflows on PRs UI UI specific issues

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants