Skip to content

Commit

Permalink
Add images
Browse files Browse the repository at this point in the history
  • Loading branch information
hanbyul-here committed Nov 18, 2024
1 parent 3d89753 commit b321724
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions open-source-ecosystem/contribute.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ Development related documentation can be found in this directory of the repo: ht

The primary goal of VEDA UI has always been to offer an easily replicable instance. Initially, VEDA UI began as a git submodule for various instances. However, after gaining an understanding of product needs, we are now transitioning VEDA UI into a registry. During this transition, we continue to release new features and fix bugs for existing instances. This is made possible by maintaining two build systems that leverage the same codebase.

![A diagram illustrating how the two build systems work: Components are built using the library build process, while page components wrap these components and are then built using the application build process.](./images/veda-dashoard-current-state.png)

If you’re working on a specific feature or bug fix, this current structure will likely not impact your work. However, you might encounter challenges similar to those faced when developing a library, such as ensuring a component can function seamlessly in both SPA (Single Page Application) and SSR (Server-Side Rendering) environments, or not using environmental variables at the component level.

## GitHub Workflow
Expand All @@ -35,6 +37,8 @@ You can select to open a draft through the dropdown of GitHub interface.

## Break down the features

![A joke meme that shows a big PR get no comment while a small PR gets so many comments](./images/contribute-small-pr.png)

It is a joke meme, but it is true that reviewing a PR that includes a lot of changes is challenging, often resulting in a hasty review.

To make the review process easy and helpful for everybody, we recommend you to consider breaking down features, so each change needed for the feature can be as small and modular as possible. For example, if the feature you are working on has multiple ‘nice to have’ - strip them down to MVP, figure out what is the minimum viable shape that we can have in production and start from there. If your change will need multiple logic changes and UI changes, consider separating them so the logic can be reviewed separately from UI change.
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit b321724

Please sign in to comment.