Skip to content

Contributors Guide

Welcome to the Digital Twin as a Service (DTaaS) contributing guide

Thank you for investing your time in contributing to our project!

Read our Code of Conduct to keep our community approachable and respectable.

In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.

Project Goals

It helps development team members get familiar with the DTaaS project software design, and development processes. Please see developer-specific Slides, Video, and Research paper.

💻 Development Environment

There is a devcontainer configuration (.devcontainer/devcontainer.json) for the project. Please use it to get a dockerized development environment. DevContainer is the easiest way to get started.

🏗 Development Workflow

To manage collaboration by multiple developers on the software, a development workflow is in place. Each developer should follow these steps:

  1. Fork of the main repository into your github account.
  2. Setup Qlty and Codecov for your fork. The codecov does not require secret token for public repositories.
  3. nvm use 22 (if nvm or node isn't installed)
  4. Use Fork, Branch, PR workflow.
  5. Work in your fork and open a PR from your working branch to your feature/distributed-demo branch. The PR will run all the github actions, qlty and codecov checks.
  6. Resolve all the issues identified in the previous step.
  7. Once changes are verified, a PR should be made to the feature/distributed-demo branch of the upstream DTaaS repository.
  8. The PR will be merged after checks by either the project administrators or the maintainers.

Remember that every PR should be meaningful and satisfies a well-defined user story or improve the code quality.

👁 Code Quality

The project code qualities are measured based on:

  • Linting issues identified by qlty. Please install qlty and use the following command to check for code quality issues. qlty check --no-fail --sample 5 --no-formatters and resolve any issues identified by the qlty. (Please note that qlty only checks the files that changed from the default branch, i.e., feature/distributed-demo).
  • Test coverage report collected by Codecov
  • Successful github actions

Qlty

Qlty performs static analysis, linting and style checks. Quality checks are performed by qlty are to ensure the best possible quality of code to add to our project.

While any new issues introduced in your code would be shown in the PR page itself, to address any specific issue, you can visit the issues or code section of the qlty page.

It is highly recommended that any code you add does not introduce new quality issues. If they are introduced, they should be fixed immediately using the appropriate suggestions from Qlty, or in worst case, adding a ignore flag (To be used with caution).

Codecov

Codecov keeps track of the test coverage for the entire project. For information about testing and workflow related to that, please see the testing page.

Github Actions

The project has multiple github actions defined. All PRs and direct code commits must have successful status on github actions.