@northeastern-web/global-elements

Global Elements Package

Dependencies

• NodeJS >= 12.x
• NPM >= 8.x
• kernl(ui) >= 2.x

Development

Builds

To build the project locally and prepare it for production use, run the following in the project's root directory:

1. npm install
2. npm run build

Preview (MacOS/Linux/WSL)

Note: To preview the Global Elements in your local development environment, ensure you have PHP configured on your machine:

1. php -S localhost:8080

Github Workflow

Feature Branching

1. Create a new Issue in the Global Elements Github repository. Provide as much context as needed for the issue
2. Checkout develop branch then create a new feature branch off of develop with the issue number and title (e.g. git checkout develop && git checkout -b issue-1/remove-trailing-slash)
3. Make fix in feature branch and create new commit with changes. Push changes to remote Github repository (e.g. git push origin issue-1/remove-trailing-slash)
4. See Github merging and releasing workflow below

Merging and Releasing

1. Create new Pull Request (PR) in the Github Repository to merge the feature branch into the develop branch
2. Add a developer from Web Solutions team to review and approve the merge.
3. Once merged, test the build on https://dev-global-packages.cdn.northeastern.edu/

Releases

This repository follows the major.minor.patch semantic versioning scheme.

To create a new release tag, run the following in the project's root directory: git tag -a v1.x.x -m "Release version x.x.x" where x.x.x is equal to the major.minor.patch semantic version.

Patches

For minor fixes or patches (no new features, fixes to existing features only), increment the ending patch version (e.g. v1.0.17 becomes v1.0.18).

Features

If there are large backwards-compatible (non-breaking) changes such as refactors or new features are being introduced, a new minor version release tag should be created (e.g. v1.1.0).

Large updates that are not backwards-compatible will require a major release (e.g. v1.0.18 becomes v2.0.0)

Usage

For up-to-date usage information, visit the kernl(ui) Global Elements documentation