Skip to content

Latest commit

 

History

History
57 lines (43 loc) · 3.25 KB

CONTRIBUTE.md

File metadata and controls

57 lines (43 loc) · 3.25 KB

Prerequisites

  • npm 10.2.4
  • node 20.11.1

Setup

  1. Install dependencies: npm ci
  2. Build: npm run build
  3. Run tests: npm run test
  4. Lint: npm run lint
  5. Generate docs: npm run generate-docs

Tests

The profiler measures itself while its tests are executed. To generate the measurements (stored in project reports) just execute the tests via npm run test

  • Since the tests regarding the profiler format are deeply connected, it is often frustrating to update all the tests when changes to the profiler format are made. To solve this issue, there is the command npm run test-update. This will update all test assets to fit the tests. However, this command will only solve tests regarding the reading and writing of the profiler format. Therefore, it is important to ensure that the changes to the profiler format are serialized correctly. In most test files, there is a runInstanceTests method that will check if everything works as expected even after writing and reading a report again. So, as long as the feature is fully tested there, it should work with serialization and deserialization.

Versioning

NOTE: The versions of the profiler and the profiler-core package are always equal, there will be no release that only increases one package version

2.3.5
│ │ │
│ │ └───────── patch level / micro release
│ └─────────── minor release
└───────────── major release

  • build number: build number

  • patch level / micro release: includes bug fixes

  • minor release: includes new features

  • major release: includes significant changes (like breaking changes or fundamental changes)

⚠️ Failing tests after version upgrade
After a version upgrade, the tests will fail because all test assets contain the previous version number. To fix this, run npm run test-update. This command will update all test assets to contain the new version number. The tests may not pass during the execution of the npm run test-update script, but running npm run test again should display the tests as passed.

Backwards Compatibility

packages/profiler-core/src/model/BackwardsCompatibility
│ └───────── versionFormats
│             │ └─────────── ProjectReportFormat-00001-0.0.9
│             └───────────── ProjectReportFormat-00002-0.0.10
└─────────── versionTransformers
              └─────────── ProjectReportTransformer-00001-0.0.9

Since measurements are stored in a self developed format (ProjectReport) it is necessary to provide backwards compatibility for this format. Therefore each release (that changes the format) of the profiler-core should provide the new version format (including the changed types) and a transformer class which contains a static method transform_projectReport to transform the format of the last release to the new format.

Generate Docs

All README files are built via the npm run generate-docs command, which uses markdown-include to build the README files. To make changes to the README files, update the Markdown files in the md-configs directory and re-generate the docs with npm run generate-docs.