# convention

Code Convention을 위한 Husky와 Lint-staged 적용
이전 포스팅에서 사내 프로젝트에 ESLint 와 Prettier 를 적용하는 과정을 다뤘었는데,이번에는 Husky 와 Lint-staged 를 활용해 작업을 자동화한 과정에 대해 짧게 작성해볼 예정이다.사실 여러 Lint Rule 들이 정의되어 프로젝트에 적용되어 있더

사내 ESLint & Prettier 적용기
최근 사내에 코드 리뷰 문화를 도입하게 되었는데, 팀원 간 컨벤션이 달라 리뷰가 어렵다는 피드백이 있었다.실제로 살펴보니 유사한 동작을 수행하는 로직들 간에도 구현되어 있는 코드 스타일이 서로 달라 읽어내는 데 생각보다 많은 리소스가 소모되었다.

[IntelliJ] 왜 자바 패키지명 맨 앞은 com?
자바를 시작한지 얼마 안된 나는 느낀게 하나 있다.왜 사람들은 혹은 인텔리제이에서는 패키지를 추가할 때 앞에 com으로 시작하게 유도하거나 사용을 할까?검색해보고 알아냈다..!https://docs.oracle.com/javase/tutorial/java/p

Python Docstring
원래 주석을 잘 달지 않는다. 혼자 다 하는데 무슨 주석이 필요한가? 다 코드에 변수에 흔적이 남아 있는데 그렇지만 중요하고 복잡한 함수와 협업에 필요한 곳에는 꼭 상세하게 달아야 한다. 나중에 html에 어떻게 변환될 지는 두째치고, 우선 내 코드에서 보기 좋은 컨벤
module import convention
모듈 import 순서 import 순서 컨벤션에 맞게 작성하는것이 어디에도 나와있지는 않지만 개발자들끼리 통상적으로 약속되어 있는 순서들이 있다. 사소한 부분이라 놓치기 쉽지만 처음 코드를 작성할 때부터 신경쓰고 작성하게 되면 추후에 관리하기도 용이하며 가독성도 좋
파일 구조가 뭐길래
개요 SCG에서 진행하는 졸업논문 시스템 리뉴얼 중에 프론트엔드 파일 구조를 정립하는데 여러 레퍼런스와 의견이 충돌. barrel export를 적용하는 방향으로 논의가 진행됨 기존에는? Ourlim 프로젝트의 경우 모든 컴포넌트 파일(tsx)은 폴더 내부에 존재하고,

구글 html / css 컨벤션(스타일 가이드)
코딩 컨벤션(coding convention) 멘토의 소개로 알게 된 google coding style gides를 읽고 평소 지키지 못했던 내용들을 정리해보았다. 불필요한 id 속성 피하기 불필요한 id 속성을 자제하고, 스타일을 위한 class와 스크립트를
C# Naming Convention
명칭에 대한 규칙(Naming Convention)에 대해서는 .NET Framework Design Guidelines 에 자세히 정리되어 있으므로 이 책을 참조하면 좋다. 여기서는 그 중 중요한 사항들만을 요약 정리해 본다. 특히, Naming Convention에

[DevOps]Git / Github 관련 규약
01 개요 본 문서에서는 git / github 사용시에 필요한 코딩규약(code convention)을 정한다. 이러한 사항은 각 개인, 집단마다 다를 수 있으며 이 코딩규약은 일반사항 및 필자가 사용하고 있는 코딩규약을 서술한다. 최종 수정일 : 2022.12.3

git hooks 를 husky 로 제어하기 (eslint, pre-commit)
팀원과 컨벤션 정의 및 lint 규칙을 정하는 상황이 있습니다. 그런데 작업을 하다 보면 서로 코드 컨벤션에 소홀해지는 경우가 있습니다. 이런 상황일 때, 사용하면 좋은 도구가 husky 입니다.

eslint(airbnb) + prettier + Next + Typescript + yarn 설정
자바스크립트 소스 코드의 오류를 표시하기 위한 도구입니다.ES란, Ecma Script, 표준 자바스크립트Lint란, 소스 코드를 분석하여 프로그램 오류, 버그, 스타일 오류 등을 표시하기 위한 도구코드를 예쁘고 일관성 있게 유지시켜주는 자동완성 도구입니다.
DB 네이밍 컨벤션
이름은 snake case를 따른다.snake case란 모든 글자를 소문자로 하고, 언더스코어(\_)로 단어를 구분해주는 방법ex) userLogin, Name (X) --> user_login, name (O)prefix와 postfix는 사용하지 않는다. (옛날

[Convention] Git Commit Message Conventions
AngularJS Git Commit Message Conventions를 정리한 포스팅입니다.

git commit convention에 관하여
우리가 작업을 하게 된다면 git을 이용한 commit 활동을 하게 된다. 개인 프로젝트 및 토이 프로젝트를 진행하는 경우에는 우리는 단순히 다음과 같은 명령어를 통해서 commit을 해봤을 것이다.git commit -m “커밋할 메시지”이 커밋할 메시지에서 자기가