Skip to content

Contributing

Development

To contribute or make adjustments:

  1. Clone the repository and install dependencies:
bash
git clone https://github.com/robuust/vue-components.git
cd vue-components
yarn install
  1. Run the development server:
bash
yarn dev
bash
yarn docs:dev
  1. Build for production:
bash
yarn build
bash
yarn build:docs

Beta Releases

When you open a pull request, a beta version is automatically published to npm. This allows you to test your changes before they are merged to main.

How it works

  1. When you open, update, or reopen a pull request, a GitHub Actions workflow automatically:

    • Generates a beta version by incrementing the minor version and adding a sequential beta number (e.g., current: 2.3.2 → beta: 2.4.0-beta.1)
    • Runs linters and tests to ensure code quality
    • Builds the package
    • Publishes to npm with the beta tag
    • Comments on the PR with installation instructions
  2. The beta version will be available on npm and can be installed using:

bash
npm install @robuust-digital/vue-components@2.4.0-beta.1
# or use the beta tag for the latest beta release
npm install @robuust-digital/vue-components@beta
  1. Each time you push to the PR, a new beta version is published with an incremented beta number (e.g., 2.4.0-beta.2, 2.4.0-beta.3, etc.)

  2. Beta versions are superseded by newer beta or stable releases and should only be used for testing purposes.

WARNING

Beta releases are intended for testing and should not be used in production environments.