DEVELOPMENT.md

Workflow for development

This document describes the workflow we use for the development of Jitar.

Environment

To work on Jitar, you need the following tools:

• Node.js 20.x or higher
• npm 10.x or higher
• Visual Studio Code
• Docker (optional) for running the full stack example

Note: Jitar is managed as a monorepo with Lerna. You don't need specific knowledge about Lerna to work on Jitar.

Installation

1. Clone the repository.
2. Run npm install to install all dependencies.

Development

1. Run npm run build to build all packages.
2. Run npm run test to run all tests.
3. Run npm run lint to lint all packages.

Creating a pull request

1. Create a new issue and branch.
2. Make your changes.
3. Update the documentation if necessary.
4. Run npm run build to build all packages.
5. Run npm run review to run all tests and linting.
6. Commit and push the changes.
7. Create a pull request.

Publishing

To do consistent releases, we use the following steps:

1. Create a new issue and branch.
2. Update the version number for the mono repo in the package.json file.
3. Update the version number for all packages in the packages directory.
4. Execute command npm run changelog to generate a changelog.
5. Commit and push the changes.
6. Execute command npm run publish to publish the packages.
7. Commit and push the changes.
8. Create pull request.
9. Merge the pull request.
10. Create a new tag with the version number.