From ac95349ac69158b7f9d5fc16692637e07bf1ff86 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=EC=84=B1=EC=9C=A0=EC=A0=95?= Date: Fri, 6 Mar 2020 13:34:54 +0900 Subject: [PATCH] Fix collaboration tools - Add naming convention --- Collaborative-Tools.md | 78 +++++++++++++++--------------------------- Naming-convention.md | 9 +++++ 2 files changed, 37 insertions(+), 50 deletions(-) create mode 100644 Naming-convention.md diff --git a/Collaborative-Tools.md b/Collaborative-Tools.md index 190ba5f..bbecef7 100644 --- a/Collaborative-Tools.md +++ b/Collaborative-Tools.md @@ -1,6 +1,6 @@ # Collaborative tools -동아리 프로젝트 및 소통을 위해 사용하는 협업도 구들의 사용법과 지켜야 할 규칙들을 정리해 놓은 문서 +동아리 프로젝트 및 소통을 위해 사용하는 협업도구들의 사용법과 지켜야 할 규칙들을 정리해 놓은 문서 ## github @@ -8,59 +8,49 @@ https://github.com/FLOSVIA github란? -프로젝트 협업능력을 높이기 위해 사용함 +프로젝트 협업능력을 높이기 위해 사용한다. ## slack - ## vscode -가장 많이쓰는 ide중엔 vscode가있다. 무조건 vscode를 쓰라는건 아니지만 이 ide를 추천한다. vscode에선 python, js, php등등 여러 방면에서 뛰어나다. extension과 단축키, 테마를 소개하도록 하겠습니다. 모든건 선택사항이므로 참고만 하자 +가장 많이 사용하는 IDE 중 하나이다. +빠른 속도, 많은 양의 plug-in을 지원하는 등 여러 방면에서 뛰어나다. ### extension - **live server** - - 프론트 개발자를 위해 html,css를 수정할시 라이브로 웹을 보여준다. - - 개인적으로 프론트개발자라면 꼭 써야한다고 생각한다. - - 별 5개중 5개 + - 프론트 개발자를 위해 html,css를 수정할 시 라이브로 웹을 보여준다. + - 5점 - **prettier** - - 코드를 예쁘게 고쳐줌 - - 코드를 더럽게 짜서 가독성이 떨어지거나 협업을할때 코딩 스타일이 달라 협업에 문제가 생길경우 사용하면 좋습니다. - - 다운받는것만 아니라 설정이 필요합니다. - - ESLint를 쓰는경우 문법에 맞지 않아 오류가 날수있습니다. - - 별 5개중 4.5개 -- **Auto Rename tag ** - - vue나 react같이 태그를 닫지 않으면 오류가 생기는 일을 방지할수있다. - - 별 5개중에 3.5개 + - 코드를 특정 규칙에 맞추어 고쳐준다. + - 코드의 가독성이 떨어지거나 협업을 할 때 코딩 스타일이 달라 협업에 문제가 생길 경우 사용하면 좋다. + - 부가적인 규칙 설정이 필요하다. + - ESLint를 쓰는 경우 문법에 맞지 않아 오류가 날 수 있다. + - 4.5점 +- **Auto Rename tag** + - vue나 react 같은 곳에서 태그를 닫지 않으면 오류가 생기는 일을 방지할 수 있다. + - 3.5점 - **Bracket Pair Colorizer** - - if문이나 함수를 여러개써서 괄호가 많아져 구분이 어려운경우가 많다. 짝이 되는 괄호끼리 색을 칠해 가독성이 높아져서 좋다. - - 너무 색이 다채로워서 눈이 아플수도 있음 - - 별 5개중에 3개 + - if문이나 함수를 여러 개를 사용하면 괄호가 많아져 구분이 어려운 경우가 많다. 짝이 되는 괄호끼리 색을 칠해 가독성이 높아져서 좋다. + - 너무 색이 다채로워서 눈이 아플수도 있다. + - 3점 - **Hightlight Matching Tag** - - 위에 있는 익스텐션과 같은 역할을 한다. 대신 괄호가아니라 태그에 색을 입힌다. + - Bracket Pair Colorize extension과 같은 역할을 한다. 대신 괄호가 아닌 태그에 색을 입힌다. - **Korean Language Pack for Visual Studio Code** - - vscode에있는 영어를 한국어로 바꿔준다. 영어울렁증이 있는 사람에게 참 좋다. - - 간지가 안날수도있음, 번역이 안되는것도 있다. - - 별5개중에 4개 + - vscode에있는 영어를 한국어로 바꿔준다. + - 번역이 안 되는 것도 있다. + - 4점 - **Live Share** - 구글 독스처럼 실시간으로 코드를 공유해준다. - - github를 잘못쓰고 매우 작은 소규모 프로젝트에 쓰면 좋을거같다. - - 내가 코딩하는거 건들이면 싸움날수도있음 - - 별 5개중 3개 + - github를 잘 못 쓰거나 매우 작은 소규모 프로젝트에 쓰면 좋을 것 같다. + - 3점 - **Markdown All in One** - - 마크다운 문법을 쉽게 쓸수있다. 마크다운이 익숙치 않을때 썼었으나 문법에 익숙해지는 게 더좋다. \ - - 마크다운 문법을 잘쓰고 싶다면 여길 보자. - - 절대 내가써서 추천해 주는거 맞다. 스타좀.. - - 별5개중 2개 -- **Power Mode** - - 타자를 칠때 타격감? 을준다. 뭔가 타자를 빠르게 치고싶은 욕구가 생겨 코딩 속도가 빨라진다. - - 세게 치다가 키보드 망가질수도(고만해..) - - 별5개중 3.5개 -- **Vue Theme** - - vue하다가 도움되는건줄 알고 다운받았는데 그냥예쁜테마 외계 행성에 풀느낌?이 난다. - - 테마가 신기하면 잘해보임 - - 별5개중에 4개 + - 마크다운 문법을 쉽게 쓸 수 있다. 마크다운이 익숙치 않을 때 쓰면 좋으나 문법에 익숙해지는 게 좋다. + - 마크다운 문법 정리 : + - 2점 + - **path intellisense** - **npm** - **eslint** @@ -73,16 +63,4 @@ github란? ### 단축키 - **CTRL + D** 선택된 문자를 중복선택 -- **CTRL + SHIFT + `** 터미널 열기 - - - -## 변수명 표기 - -협업을 하다보면 변수명의 일관성이 없어 혼란이 오는경우가 많다. 그런 것들을 방지하기위해 표기법을 정해두자. - - - -변수명 표기법엔 여러가지가 있는데 변수를 선언할땐 카멜표기법을 사용한다. - -파일명이나 폴더명엔 파스칼표기법을 사용하도록한다. \ No newline at end of file +- **CTRL + SHIFT + `** 터미널 열기 \ No newline at end of file diff --git a/Naming-convention.md b/Naming-convention.md new file mode 100644 index 0000000..38d4e77 --- /dev/null +++ b/Naming-convention.md @@ -0,0 +1,9 @@ +# Naming-convention + +협업을 하다 보면 변수명의 일관성이 없어 혼란이 오는 경우가 많다. 이를 방지하기 위하여 변수 표기법을 정하는 것이 좋다. + + + +변수명 표기법에는 여러가지가 있는데 변수를 선언할 때는 카멜표기법을 사용한다. + +파일명이나 폴더명엔 파스칼표기법을 사용하도록 한다. \ No newline at end of file