SSWConsulting / SSWConsulting/SSW.Website

📦 Breaking out the components into a separate npm package

Open
#3,416 9 comments 0 reactions 1 assignee View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
14
Forks
10
Avg merge
13h 51m
Merged PRs (30d)
38

Description

Description

I want to break out new components into a separate NPM package.

Tasks

  • Create the new NPM package structure.
  • Refactor components into the package, ensuring separation of concerns.
  • Update imports in the main project to use the new package.
  • Set up CI/CD pipeline for the package.
  • Write or update documentation for the package.
  • Test the integration of the package with the main project.

Acceptance Criteria

  • A new NPM package is created and published under the organization's registry.
  • Components are refactored out of the main project into the new package, maintaining full functionality.
  • Documentation for the new package includes:
    • Installation instructions
    • Usage examples for each component
    • Versioning guidelines
  • The main project is updated to consume the new NPM package instead of the local components.
  • CI/CD pipeline is set up for the new package to handle:
    • Linting
    • Publishing to the registry

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.