Skip to content

RULES.md

Latest commit

 

History

History
241 lines (185 loc) · 4.69 KB

RULES.md

File metadata and controls

241 lines (185 loc) · 4.69 KB

프로젝트 규칙

개요

이 문서는 cozzin.github.io 블로그 프로젝트의 규칙과 가이드라인을 정의합니다.

기본 원칙

1. 품질 우선

  • 모든 콘텐츠는 높은 품질을 유지해야 합니다
  • 정확하고 유용한 정보를 제공합니다
  • 독자에게 가치를 전달하는 것을 목표로 합니다

2. 일관성 유지

  • 코드 스타일과 문서 형식의 일관성을 유지합니다
  • 카테고리와 태그 체계를 일관되게 사용합니다
  • 네이밍 컨벤션을 준수합니다

3. 지속 가능성

  • 장기적으로 유지보수 가능한 구조를 유지합니다
  • 확장 가능한 아키텍처를 고려합니다
  • 기술 부채를 최소화합니다

콘텐츠 규칙

포스트 작성 규칙

1. 제목 규칙

  • 명확하고 구체적인 제목 사용
  • 검색 최적화를 고려한 키워드 포함
  • 50자 이내로 작성

2. 내용 규칙

  • 구조화: 명확한 목차와 섹션 구분
  • 실용성: 실제 사용 가능한 예제 포함
  • 정확성: 기술적 정확성 보장
  • 가독성: 이해하기 쉬운 설명

3. 코드 예제 규칙

  • 완전하고 실행 가능한 코드 제공
  • 주석을 통한 설명 추가
  • 언어별 문법 하이라이팅 적용
  • 복사 가능한 형태로 제공

4. 이미지 규칙

  • 고품질 이미지 사용
  • 적절한 크기와 압축
  • alt 텍스트 제공
  • 저작권 고려

카테고리 및 태그 규칙

카테고리 체계

Swift/iOS
├── Swift 언어
├── iOS 개발
├── 메모리 관리
└── 성능 최적화

Backend
├── Spring Boot
├── Java
└── 데이터베이스

Architecture
├── RIBs
├── MVVM
└── Clean Architecture

Cloud/DevOps
├── AWS
├── Docker
└── CI/CD

Testing
├── Unit Test
├── UI Test
└── TDD

Refactoring
└── 코드 개선

태그 규칙

  • 구체적이고 검색 가능한 태그 사용
  • 중복 태그 방지
  • 일관된 태그명 사용
  • 최대 5개까지 사용

기술적 규칙

파일 구조 규칙

1. 포스트 파일

_posts/
├── YYYY-MM-DD-title.md
└── drafts/
    └── draft-title.md

2. 이미지 파일

assets/
├── images/
│   ├── posts/
│   │   └── YYYY-MM-DD-title/
│   └── common/
└── 2021/
    └── MM/

3. 설정 파일

_data/
├── locales/
├── contact.yml
└── share.yml

코드 품질 규칙

1. Jekyll 설정

  • 명확한 주석 추가
  • 환경별 설정 분리
  • 보안 정보 보호

2. HTML/CSS

  • 시맨틱 HTML 사용
  • 접근성 고려
  • 반응형 디자인

3. JavaScript

  • ES6+ 문법 사용
  • 에러 처리
  • 성능 최적화

커뮤니케이션 규칙

1. 이슈 관리

  • 명확한 제목과 설명
  • 라벨을 통한 분류
  • 템플릿 사용

2. Pull Request

  • 작은 단위로 분할
  • 명확한 설명
  • 테스트 포함

3. 리뷰 프로세스

  • 건설적인 피드백
  • 코드 품질 검토
  • 문서화 확인

보안 규칙

1. 민감 정보 보호

  • API 키는 환경 변수 사용
  • 개인 정보 노출 금지
  • 보안 취약점 즉시 수정

2. 의존성 관리

  • 정기적인 업데이트
  • 보안 취약점 스캔
  • 불필요한 의존성 제거

성능 규칙

1. 로딩 속도

  • 이미지 최적화
  • CSS/JS 압축
  • CDN 활용

2. SEO 최적화

  • 메타 태그 관리
  • 구조화된 데이터
  • 사이트맵 생성

모니터링 규칙

1. 분석 도구

  • Google Analytics 활용
  • 사용자 행동 분석
  • 성능 모니터링

2. 오류 추적

  • 빌드 오류 즉시 수정
  • 사용자 피드백 수집
  • 정기적인 점검

업데이트 규칙

1. 정기 업데이트

  • 월 1회 이상 포스트 작성
  • 분기별 테마 업데이트
  • 연간 기술 스택 검토

2. 긴급 업데이트

  • 보안 취약점 발견 시 즉시 수정
  • 중요한 오류 발견 시 즉시 수정
  • 사용자 피드백 반영

라이선스 및 저작권

1. 콘텐츠 라이선스

  • MIT 라이선스 적용
  • 출처 명시
  • 상업적 이용 가능

2. 이미지 라이선스

  • 저작권 확인
  • 적절한 라이선스 사용
  • 출처 명시

예외 처리

1. 규칙 위반 시

  • 즉시 수정 요청
  • 교육적 접근
  • 점진적 개선

2. 긴급 상황

  • 우선순위 재조정
  • 임시 조치
  • 사후 검토

규칙 업데이트

이 규칙은 프로젝트의 발전에 따라 정기적으로 검토되고 업데이트됩니다.

업데이트 절차

  1. 이슈 생성
  2. 토론 및 검토
  3. 규칙 수정
  4. 공지 및 적용

마지막 업데이트: 2024년 1월 다음 검토 예정: 2024년 4월