Team Rules - codestates/BuildUp-client GitHub Wiki

Team Rules

1. ๊ธฐ๋ณธ๊ทœ์น™

  • ํŠน์ด์‚ฌํ•ญ ๋ฐœ์ƒ์‹œ ํŒ€์›๋“ค์ด ์•Œ ์ˆ˜ ์žˆ๋„๋ก ๋‹น์ผ ํšŒ์˜์‹œ์ž‘ 30๋ถ„ ์ „๊นŒ์ง€ ํŒ€์žฅ์—๊ฒŒ ์•Œ๋ฆฝ๋‹ˆ๋‹ค.

2. Issue Card ํ˜•์‹

## Fill the title according to the below form
[Client/Server/Database] / [#์ด์Šˆ๋ฒˆํ˜ธ] / edit: [์ˆ˜์ •ํ•œ ํŒŒ์ผ๋ช…]

## ISSUE
* Group: client, server, database
* Type: add, fix, delete
* Detail: fix actions from group

## TODO
- [x] Job1
- [x] Job2
- [x] Job3

## Estimated time
> Pick one of the below
> 0.5h / 1h / 1.5h / 2h / 2.5h / 3h

## Labels
Estimated time: E: 1h
Group : client, server
Sprint: Sprint__NUMBER__
Urgency: High, Middle, Low


3. ๊นƒ ๋ธŒ๋žœ์น˜ ์ƒ์„ฑ๊ทœ์น™

  • feature/#[์ด์Šˆ๋ฒˆํ˜ธ]-[๊ธฐ๋Šฅ์ด๋ฆ„]

์˜ˆ์‹œ1: feature/#11-login
์˜ˆ์‹œ2: feature/#21-logout

  • bugfix/#[์ด์Šˆ๋ฒˆํ˜ธ]/[๊ธฐ๋Šฅ์ด๋ฆ„]

์˜ˆ์‹œ: bugfix/#31/login

4. ์ปค๋ฐ‹ ์ž‘์„ฑ๊ทœ์น™

  • [๋™์ž‘] #[์ด์Šˆ๋ฒˆํ˜ธ] - [๋‚ด์šฉ]

์˜ˆ์‹œ1: Add #11 - edit: login
์˜ˆ์‹œ2: Fix #24 - edit: logout

5. PR ์ œ๋ชฉํ˜•์‹

  • [Client/Server/Database] / [#์ด์Šˆ๋ฒˆํ˜ธ] / edit: [์ˆ˜์ •ํ•œ ํŒŒ์ผ๋ช…]

FE ์˜ˆ์‹œ: [Client] / #11 / edit: login
BE ์˜ˆ์‹œ: [Server] / #24 / edit: logout

  • PR ๋‚ด์šฉ์€ Issue Card๋ฅผ ์ฐธ๊ณ ํ•˜์—ฌ ์ž‘์„ฑํ•ฉ๋‹ˆ๋‹ค.

6. ESlint

Client Eslint, prettier settings
devDependncy๋กœ node packages๋ฅผ ์„ค์น˜ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค.

npm install prettier --save-dev
npm install eslint-config-prettier --save-dev
npm install eslint-plugin-prettier --save-dev

package.json์˜ eslintConfig์™€ prettierrc.json์ด ์•„๋ž˜๋‚ด์šฉ๊ณผ ์ผ์น˜ํ•˜๋Š”์ง€ ํ™•์ธํ•ฉ๋‹ˆ๋‹ค.

// package.json
{
  "extends": [
    "react-app",
    "plugin:prettier/recommend"
 ]
}

// .prettierrc.json
{
  "singleQuote": false,
  "semi": true,
  "useTabs": false,
  "tabWidth": 2,
  "trailingComma": "all",
  "printWidth": 80
}

// VSCode settings.json
{
    "editor.codeActionsOnSave": {
        "source.fixAll.eslint": true,
        "source.fixAll": true,
    },
    "editor.formatOnSave": true,
    // ESLint, Prettier์˜ Autofix on Save๊ฐ€ ์ž‘๋™ํ•˜์ง€ ์•Š์œผ๋ฉด,
    // ๋‹ค์Œ ์ฝ”๋“œ๋ฅผ ์ž…๋ ฅํ•˜์—ฌ Formatter๋ฅผ Prettier๋กœ ์„ค์ •ํ•ด์•ผ ํ•œ๋‹ค.
    "editor.defaultFormatter": "esbenp.prettier-vscode",
}

7. node, nvm version

  • Node v14.16.0.
  • NPM v6.14.11