Merge branch 'develop'

Author: dolfinus

.github/workflows/cache-cleanup.yml

@@ -17,7 +17,7 @@ jobs:
 
         steps:
             - name: Check out code
-              uses: actions/checkout@v5
+              uses: actions/checkout@v6
 
             - name: Cleanup cache
               run: |

.github/workflows/linters.yml

@@ -22,13 +22,13 @@ jobs:
 
         steps:
             - name: Checkout code
-              uses: actions/checkout@v5
+              uses: actions/checkout@v6
 
             - name: Install Node.JS
               uses: actions/setup-node@v6
 
             - name: Cache modules
-              uses: actions/cache@v4
+              uses: actions/cache@v5
               with:
                   path: ./node_modules
                   key: ${{ runner.os }}-npm-${{ hashFiles('**/package-lock.json') }}

.github/workflows/release.yml

@@ -38,7 +38,7 @@ jobs:
               uses: actions/setup-node@v6
 
             - name: Checkout code
-              uses: actions/checkout@v5
+              uses: actions/checkout@v6
 
             - name: Get version
               id: get_version

.github/workflows/repo-labels-sync.yml

@@ -24,7 +24,7 @@ jobs:
 
         steps:
             - name: Checkout
-              uses: actions/checkout@v5
+              uses: actions/checkout@v6
 
             - name: Run Labeler
               uses: crazy-max/ghaction-github-labeler@v5

.husky/pre-commit

@@ -1 +1,2 @@
 npx lint-staged
+npm run type-check

.prettierignore

@@ -0,0 +1,4 @@
+*.html
+*.svg
+!public/upload*.html
+build

.prettierrc

@@ -1,36 +1,102 @@
-# Development
+# Contributing Guide
 
-To explore the source code, start with [src/App.tsx](./src/App.tsx).
+Welcome! There are many ways to contribute, including submitting bug
+reports, improving documentation, submitting feature requests, reviewing
+new submissions, or contributing code that can be incorporated into the
+project.
 
-## How to run
+## Review process
 
-After having cloned the Rentgen repository, run the following commands at the root directory:
+For any **significant** changes please create a new GitHub issue and
+enhancements that you wish to make. Describe the feature you would like
+to see, why you need it, and how it will work. Discuss your ideas
+transparently and get community feedback before proceeding.
+
+Small changes can directly be crafted and submitted to the GitHub
+Repository as a Pull Request. This requires creating a **repo fork** using
+[instruction](https://docs.github.com/en/get-started/quickstart/fork-a-repo).
+
+## Initial setup for local development
+
+### Install Git
+
+Please follow
+[instruction](https://docs.github.com/en/get-started/quickstart/set-up-git).
+
+### Clone the repo
+
+Open terminal and run these commands:
+
+```bash
+git clone [email protected]:myuser/data-rentgen-ui.git
+
+cd data-rentgen-ui
+```
+
+### Setup environment
+
+To install all necessary dependencies, run these commands:
 
 ```bash
 npm ci
+npm run pre-commit-install
+```
+
+# How to
+
+## Run development server
+
+```bash
 npm run dev
 ```
 
-These commands will install dependencies and launch the dev server, by going to localhost:3000 you can go to the Rentgen UI interface.
+### Create pull request
+
+Commit your changes:
+
+```bash
+git commit -m "Commit message"
+git push
+```
+
+Then open Github interface and [create pull request](https://docs.github.com/en/get-started/quickstart/contributing-to-projects#making-a-pull-request).
+Please follow guide from PR body template.
 
-## How to format code
+After pull request is created, it get a corresponding number, e.g. 123
+(`pr_number`).
 
-Run the following command at the root directory:
+## Release Process
+
+Note: this is only for repo maintainers
+
+0. Checkout to ``develop`` branch and update it to the actual state
 
 ```bash
-npm run prettier-format
+git checkout develop
+git pull -p
 ```
 
-## How to run linters
+1. Merge ``develop`` branch to ``master``, **WITHOUT** squashing
 
-Run the following command at the root directory:
+```bash
+git checkout master
+git pull
+git merge develop
+git push
+```
+
+2. Add git tag to the latest commit in ``master`` branch
 
 ```bash
-npm run lint
+git tag "$VERSION"
+git push origin "$VERSION"
 ```
 
-## How to install pre-commit hooks
+VERSION should be the same as for backend.
+
+3. Update version in ``develop`` branch **after release**:
 
 ```bash
-npm run pre-commit-install
+sed -i "s#\"version\": \"[[:digit:]]\.[[:digit:]]\.[[:digit:]]\"#\"version\": \"$VERSION\"#" package.json package-lock.json
+npm i
 ```

CONTRIBUTING.md

@@ -1,4 +1,4 @@
-Copyright 2024-2025 MTS PJSC.  All rights reserved.
+Copyright 2024-present MTS PJSC.  All rights reserved.
 
                                  Apache License
                            Version 2.0, January 2004