From 729aa9781ad258d50e91f502a63206218b94ccb1 Mon Sep 17 00:00:00 2001 From: Fabio Di Stasio Date: Sun, 31 Oct 2021 16:07:53 +0100 Subject: [PATCH] chore: update README.md and CONTRIBUTING.md --- .all-contributorsrc | 117 ++++++++++++++++++++++++++++++++++++++++++++ CONTRIBUTING.md | 37 +++++--------- README.md | 42 ++++++++++++---- package.json | 7 ++- 4 files changed, 167 insertions(+), 36 deletions(-) create mode 100644 .all-contributorsrc diff --git a/.all-contributorsrc b/.all-contributorsrc new file mode 100644 index 00000000..39e1aa91 --- /dev/null +++ b/.all-contributorsrc @@ -0,0 +1,117 @@ +{ + "projectName": "Antares", + "projectOwner": "Fabio286", + "repoType": "github", + "repoHost": "https://github.com", + "files": [ + "README.md" + ], + "imageSize": 100, + "commit": false, + "commitConvention": "angular", + "contributors": [ + { + "login": "Fabio286", + "name": "Fabio Di Stasio", + "avatar_url": "https://avatars.githubusercontent.com/u/31471771?v=4", + "profile": "https://fabiodistasio.it/", + "contributions": [ + "code", + "translation", + "doc" + ] + }, + { + "login": "toriphes", + "name": "Giulio Ganci", + "avatar_url": "https://avatars.githubusercontent.com/u/4192159?v=4", + "profile": "https://www.linkedin.com/in/giulioganci/", + "contributions": [ + "code" + ] + }, + { + "login": "digitalgopnik", + "name": "Christian Ratz", + "avatar_url": "https://avatars.githubusercontent.com/u/2630316?v=4", + "profile": "https://christianratz.de/", + "contributions": [ + "code", + "translation" + ] + }, + { + "login": "reverb6821", + "name": "Giuseppe Gigliotti", + "avatar_url": "https://avatars.githubusercontent.com/u/55198803?v=4", + "profile": "https://reverb6821.github.io/", + "contributions": [ + "translation" + ] + }, + { + "login": "Mohd-PH", + "name": "Mohd-PH", + "avatar_url": "https://avatars.githubusercontent.com/u/9362157?v=4", + "profile": "https://github.com/Mohd-PH", + "contributions": [ + "translation" + ] + }, + { + "login": "hongkfui", + "name": "hongkfui", + "avatar_url": "https://avatars.githubusercontent.com/u/37477191?v=4", + "profile": "https://github.com/hongkfui", + "contributions": [ + "translation" + ] + }, + { + "login": "MrAnyx", + "name": "Robin", + "avatar_url": "https://avatars.githubusercontent.com/u/44176707?v=4", + "profile": "https://github.com/MrAnyx", + "contributions": [ + "translation" + ] + }, + { + "login": "daeleduardo", + "name": "Daniel Eduardo", + "avatar_url": "https://avatars.githubusercontent.com/u/8599078?v=4", + "profile": "https://github.com/daeleduardo", + "contributions": [ + "translation" + ] + }, + { + "login": "datlechin", + "name": "Ngรด Quแป‘c ฤแบกt", + "avatar_url": "https://avatars.githubusercontent.com/u/56961917?v=4", + "profile": "https://ngoquocdat.com/", + "contributions": [ + "translation" + ] + }, + { + "login": "IsamuSugi", + "name": "Isamu Sugiura", + "avatar_url": "https://avatars.githubusercontent.com/u/7746658?v=4", + "profile": "https://github.com/IsamuSugi", + "contributions": [ + "translation" + ] + }, + { + "login": "Occhioverde", + "name": "Riccardo Sacchetto", + "avatar_url": "https://avatars.githubusercontent.com/u/18429412?v=4", + "profile": "http://rsacchetto.nexxontech.it/", + "contributions": [ + "platform" + ] + } + ], + "contributorsPerLine": 7 +} diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 05e1ee49..7fd4e9d4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -57,8 +57,8 @@ The command to build Antares SQL locally is `npm run build:local`. - **PascalCase** for file names (with .vue extension) and including components inside others (``). - "**Base**" prefix for [base component names](https://vuejs.org/v2/style-guide/#Base-component-names-strongly-recommended). -- "**The**" prefix for [single-instance component names](https://vuejs.org/v2/style-guide/#Single-instance-component-names-strongly-recommended). -- [Tightly coupled component names ](https://vuejs.org/v2/style-guide/#Tightly-coupled-component-names-strongly-recommended). +- "**The**" prefix for [single-instance component names](https://vuejs.org/v2/style-guide/#Single-instance-component-names-strongly-recommended). +- [Tightly coupled component names](https://vuejs.org/v2/style-guide/#Tightly-coupled-component-names-strongly-recommended). - [Order of words in component names](https://vuejs.org/v2/style-guide/#Order-of-words-in-component-names-strongly-recommended). - **kebab-case** in templates for property and event names. @@ -74,15 +74,21 @@ The project includes [ESlint](https://eslint.org/) and [StyleLint](https://style Alternatively you can launch following commands to lint the project. Check if all the style rules have been followed: + ```console npm run lint ``` Apply style rules globally if possible: + ```console npm run lint:fix ``` +### Other recommendations + +Please, use if possible **template literals** to compose strings and **avoid unnecessary dependencies**. + ### Commits The commit style adopted for this project is [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/). @@ -91,30 +97,11 @@ For Visual Studio Code users may be useful [Conventional Commits](https://market ## Debug -**Dev mode**: +**Debug mode**: ```console -npm run dev +npm run debug ``` -**Visual Studio Code:** - -``` json -{ - "version": "0.2.0", - "configurations": [ - { - "type": "node", - "request": "launch", - "name": "Launch Electron in debugger", - "autoAttachChildProcesses": true, - "runtimeExecutable": "${workspaceRoot}/node_modules/.bin/electron-webpack", - "runtimeArgs": [ - "dev" - ], - "env": {}, - "console": "integratedTerminal", - } - ] -} -``` +After running the debug mode Antares will listen on port 9222 (main process) for a debugger. +On **Visual Studio Code** just launch "*Electron: Main*" configurations after running Antares in debug mode. diff --git a/README.md b/README.md index 57406600..af1fe470 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,9 @@ + +

+ # Antares SQL Client @@ -104,13 +107,34 @@ This is a roadmap with major features will come in near future. - ๐Ÿ“– [Contributors Guide](https://github.com/Fabio286/antares/wiki/Contributors-Guide) - ๐Ÿšง [Project Board](https://github.com/users/Fabio286/projects/1) -## Translations +## Contributors โœจ -**Italian** / [Giuseppe Gigliotti](https://github.com/ReverbOD) [[#20](https://github.com/Fabio286/antares/pull/20)] -**Arabic** (needs updates) / [Mohd-PH](https://github.com/Mohd-PH) [[#29](https://github.com/Fabio286/antares/pull/29)] -**Spanish** (needs updates) / [hongkfui](https://github.com/hongkfui) [[#32](https://github.com/Fabio286/antares/pull/32)] -**French** (needs updates) / [MrAnyx](https://github.com/MrAnyx) [[#44](https://github.com/Fabio286/antares/pull/44)] -**Portugues (Brasil)** / [Daniel Eduardo](https://github.com/daeleduardo) [[#54](https://github.com/Fabio286/antares/pull/54)] -**Deutsch (Deutschland)** / [Christian Ratz](https://github.com/digitalgopnik) [[#74](https://github.com/Fabio286/antares/pull/74)] -**Vietnamese** / [Ngรด Quแป‘c ฤแบกt](https://github.com/datlechin) [[#111](https://github.com/Fabio286/antares/pull/111)] -**Japanese** / [Isamu Sugiura](https://github.com/IsamuSugi) [[#115](https://github.com/Fabio286/antares/pull/115)] +Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): + + + + + + + + + + + + + + + + + + + + +

Fabio Di Stasio
๐Ÿ’ป ๐ŸŒ ๐Ÿ“–
Giulio Ganci
๐Ÿ’ป
Christian Ratz
๐Ÿ’ป ๐ŸŒ
Giuseppe Gigliotti
๐ŸŒ
Mohd-PH
๐ŸŒ
hongkfui
๐ŸŒ
Robin
๐ŸŒ

Daniel Eduardo
๐ŸŒ
Ngรด Quแป‘c ฤแบกt
๐ŸŒ
Isamu Sugiura
๐ŸŒ
Riccardo Sacchetto
๐Ÿ“ฆ
+ + + + + + +This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! diff --git a/package.json b/package.json index 37b90499..08617900 100644 --- a/package.json +++ b/package.json @@ -20,7 +20,9 @@ "postinstall": "electron-builder install-app-deps", "test": "npm run lint", "lint": "eslint . --ext .js,.vue && stylelint \"./src/**/*.{css,scss,sass,vue}\"", - "lint:fix": "eslint . --ext .js,.vue --fix && stylelint \"./src/**/*.{css,scss,sass,vue}\" --fix" + "lint:fix": "eslint . --ext .js,.vue --fix && stylelint \"./src/**/*.{css,scss,sass,vue}\" --fix", + "contributors:add": "all-contributors add", + "contributors:generate": "all-contributors generate" }, "author": "Fabio Di Stasio ", "main": "./dist/main.js", @@ -122,6 +124,7 @@ "devDependencies": { "@babel/eslint-parser": "^7.15.7", "@babel/preset-env": "^7.15.8", + "all-contributors-cli": "^6.20.0", "babel-loader": "^8.2.3", "chalk": "^4.1.2", "clean-webpack-plugin": "^4.0.0", @@ -157,4 +160,4 @@ "webpack-cli": "^4.9.1", "webpack-dev-server": "^3.11.2" } -} +} \ No newline at end of file