https://github.com/kong/kongponents

🦍 Kong Vue Component Library
https://github.com/kong/kongponents

component-library vue

Last synced: 4 days ago
JSON representation

🦍 Kong Vue Component Library

• Host: GitHub
• URL: https://github.com/kong/kongponents
• Owner: Kong
• License: apache-2.0
• Created: 2018-03-21T21:11:01.000Z (almost 7 years ago)
• Default Branch: main
• Last Pushed: 2025-02-17T05:14:23.000Z (4 days ago)
• Last Synced: 2025-02-17T06:23:00.999Z (4 days ago)
• Topics: component-library, vue
• Language: Vue
• Homepage: https://kongponents.konghq.com
• Size: 25.3 MB
• Stars: 144
• Watchers: 31
• Forks: 24
• Open Issues: 18
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        

# Kongponents

[![Kong Kongponents](/docs/public/img/kongponents-logo.jpg?raw=true)][docsUrl]

[![Publish](https://github.com/Kong/kongponents/actions/workflows/publish.yaml/badge.svg)](https://github.com/Kong/kongponents/actions/workflows/publish.yaml)

[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

[![Netlify Status](https://api.netlify.com/api/v1/badges/426d5e0a-fc41-4c1d-ba80-38417b614394/deploy-status?branch=main)](https://app.netlify.com/sites/kongponents/deploys)

Kongponents is a Vue component library of frequently needed UI elements. They were developed to solve [Kong's](https://konghq.com) application needs, but are generic enough to use in any web application.

## Documentation

[Kongponents Docs][docsUrl] are powered by VitePress and the source can be viewed [here](docs/).

[docsUrl]: https://kongponents.konghq.com

### Committing Changes

This repo uses [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).

[Commitizen](https://github.com/commitizen/cz-cli) and [Commitlint](https://github.com/conventional-changelog/commitlint) are used to help build and enforce commit messages.

It is __highly recommended__ to use the following command in order to create your commits:

```sh

pnpm commit

```

This will trigger the Commitizen interactive prompt for building your commit message.

#### Enforcing Commit Format

[Lefthook](https://github.com/evilmartians/lefthook) is used to manage Git Hooks within the repo. A `commit-msg` hook is automatically setup that enforces commit message stands with `commitlint`, see [`lefthook.yaml`](./lefthook.yaml).

### Approvals

- All pull requests require review and approval from authorized team members.

- Automated approvals through workflows are strictly prohibited.

  - There is an exception for automated pull request approvals originating from generated dependency updates that satisfy status checks and other requirements.

- Protected branches require at least one approval from code owners.

- All status checks must pass before a pull request may be merged.