-
Notifications
You must be signed in to change notification settings - Fork 1.5k
chore(ui): add ui guide for developers #24418
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
|
aniketkatkar97
approved these changes
Nov 20, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.



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.mdis updated to reference this handbook and provide onboarding instructions for new contributors.Documentation improvements:
DEVELOPER_HANDBOOK.mdfile 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.README.mdto 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:
Checklist:
Fixes <issue-number>: <short explanation>