Skip to content
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

organize repository for easier code reuse #32

Draft
wants to merge 26 commits into
base: main
Choose a base branch
from
Draft

Conversation

grahamcrackers
Copy link
Contributor

Description

We need to organize this repository for easier code reuse. Currently the repositories are being mirrored from Adobe's private repository, but the open source repository should be the source of truth. I am currently refactoring the project to update to an easier DX experience. Clients are still free to fork this repository, but will also be able to use the <LiveSearchPLP /> from the npm repository.

To better facilitate these widgets, I will continue to update the changes below and provide a list of breaking changes (if any).

Changes

  • Clean up root folder and put files in appropriate folders.
  • Use yarn instead of npm for easier.
  • Use better prettier settings for more readable files.
  • Use vite instead of webpack for better DX.
  • Update icon imports for easier use
  • Use zod (maybe json schema?) for dev validation, but strip validation in production.
  • Test components(s) with github workflows.
  • Deploy component(s) to npm with github workflows.
  • Update README to reflect new usage patterns.

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • I have signed the Adobe Open Source CLA.
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

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