Improve contributing experience

Author: dolfinus

.github/workflows/linters.yml

@@ -35,14 +35,8 @@ jobs:
       - name: Install modules
         run: yarn install --immutable
 
-      - name: Run Type check
-        run: yarn type-check
-
-      - name: Run ESLint
-        run: yarn lint
-
-      - name: Run Prettier
-        run: yarn prettier --check
+      - name: Run checks
+        run: yarn check
 
       - name: Build project
         run: yarn build

.husky/pre-commit

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

.prettierignore

@@ -4,5 +4,3 @@ yarn.lock
 *.html
 !public/upload*.html
 build
-*.d.ts
-*.json

CONTRIBUTING.md

@@ -1,29 +1,102 @@
-# SyncMaster UI
+# Contributing Guide
 
-## Getting started
+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.
 
-### Development
+## Review process
 
-First, install the dependencies of the project:
+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/syncmaster-ui.git
+
+cd syncmaster-ui
+```
+
+### Setup environment
+
+To install all necessary dependencies, run these commands:
+
+```bash
+yarn install --immutable
+yarn run pre-commit-install
+```
+
+# How to
+
+## Run development server
 
 ```bash
-yarn
+yarn run dev
 ```
 
-Run the application in development mode:
+### Create pull request
+
+Commit your changes:
+
 ```bash
-yarn start
+git commit -m "Commit message"
+git push
 ```
-Open [https://localhost:3000](https://localhost:3000) with your browser to see the result.
 
-### Linters
+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.
+
+After pull request is created, it get a corresponding number, e.g. 123
+(`pr_number`).
+
+## Release Process
+
+Note: this is only for repo maintainers
+
+0. Checkout to ``develop`` branch and update it to the actual state
+
+```bash
+git checkout develop
+git pull -p
+```
+
+1. Merge ``develop`` branch to ``master``, **WITHOUT** squashing
+
+```bash
+git checkout master
+git pull
+git merge develop
+git push
+```
+
+2. Add git tag to the latest commit in ``master`` branch
+
+```bash
+git tag "$VERSION"
+git push origin "$VERSION"
+```
 
-When you commit your changes, the pre-commit operation will be launched using husky and lint-staged packages. This setting is installed automatically along with the installation of dependencies.
+VERSION should be the same as for backend.
 
-### Build
+3. Update version in ``develop`` branch **after release**:
 
-If you want to build the project, use next command:
 ```bash
-yarn build
+sed -i "s#\"version\": \"[[:digit:]]\.[[:digit:]]\.[[:digit:]]\"#\"version\": \"$VERSION\"#" package.json package-lock.json
+npm i
 ```
-Then use `yarn start:prod` for running the project in production mode.

package.json

@@ -6,16 +6,17 @@
   "license": "Apache-2.0",
   "packageManager": "[email protected]",
   "scripts": {
-    "start": "cross-env NODE_ENV=development webpack serve",
-    "start:prod": "cross-env NODE_ENV=production webpack serve",
+    "dev": "cross-env NODE_ENV=development webpack serve",
+    "prod": "cross-env NODE_ENV=production webpack serve",
     "build": "rimraf ./dist && cross-env NODE_OPTIONS=--max_old_space_size=8192 && cross-env NODE_ENV=production webpack",
-    "lint": "eslint .",
+    "lint": "eslint --fix src/**/*.tsx src/**/*.ts",
+    "lint-check": "eslint src/**/*.tsx src/**/*.ts",
     "type-check": "tsc --noEmit",
+    "prettier": "prettier 'src/**/*.{ts,tsx,js,json}' --write --list-different",
+    "prettier-check": "prettier 'src/**/*.{ts,tsx,js,json}' --check --list-different",
+    "bundle-analyze": "cross-env BUNDLE_ANALYZER=true cross-env NODE_ENV=production webpack --progress",
     "check": "yarn lint && yarn type-check",
-    "prettier:check": "prettier --check \"**/*.{ts,tsx}\"",
-    "prettier:write": "prettier --write \"**/*.{ts,tsx}\"",
-    "bundle:analyze": "cross-env BUNDLE_ANALYZER=true cross-env NODE_ENV=production webpack --progress",
-    "prepare": "husky"
+    "pre-commit-install": "husky"
   },
   "dependencies": {
     "@ant-design/icons": "5.6.1",
@@ -79,15 +80,7 @@
     "npm": ">10"
   },
   "lint-staged": {
-    "*.(ts|tsx|js|jsx)": [
-      "node tsc-check.js",
-      "eslint --fix",
-      "prettier --write"
-    ]
-  },
-  "husky": {
-    "hooks": {
-      "pre-commit": "yarn lint-staged"
-    }
+    "src/**/*": "prettier --write --list-different",
+    "src/**/*.{ts,tsx}": "eslint --fix"
   }
 }

src/shared/config/i18n/i18n.d.ts

@@ -1,9 +1,9 @@
-import "i18next";
-import en from "./translations/en.json"
+import 'i18next';
+import en from './translations/en.json';
 
-declare module "i18next" {
+declare module 'i18next' {
   interface CustomTypeOptions {
-    resources: typeof en,
-    defaultNS: 'shared'
+    resources: typeof en;
+    defaultNS: 'shared';
   }
-}
+}