Aldra | Infrastructure modules

A collection of reusable infrastructure modules.

Table of Contents

• Contributing
  • Development environment
  • Implementing changes
  • Releasing new versions

Contributing

Development environment

The project is structured as a monorepo and is managed by Lerna.

Follow the outlined steps in order to set up a development environment.

Step 1 - Install dependencies

npm install

Step 2 - Run preparation script

npm run prepare

Implementing changes

In order to implement changes, create a branch from master branch, commit changes and open a pull request. Use atomic conventional commits to add changes to Git history. Use npm run commit to start an interactive wizard that helps with formatting commits according to specified standard.

Releasing new versions

Once changes are approved by pull request reviewers, merge the pull request to master branch. This will trigger an automatic release workflow in GitHub Actions. Follow along to make sure it completes successfully.