[집중코스 2차] 코드기여를 하고 싶으시다면! 공통컴포넌트 컨트리뷰션! 함께 해볼까요?
- PMD 활용 소프트웨어 보안 약점 진단: 표준 프레임워크 4.3 버전에서 PMD를 활용하여 소프트웨어 보안 약점을 진단하고 제거하는 방법을 소개합니다. 🛡️
- 표준 프레임워크 룰셋 적용: PMD의 방대한 기본 룰셋 대신, 표준 프레임워크에서 제공하는 45개의 특정 룰셋을 다운로드하여 적용하는 과정을 상세히 설명합니다. ⚙️
- PMD 룰셋 임포트 및 설정: 이클립스 환경에서 PMD 룰셋을 임포트하고, 기존 룰을 제거한 후 새로운 45개 룰셋을 적용하는 구체적인 단계를 시연합니다. 🛠️
printStackTrace 제거 및 Logger 대체: e.printStackTrace()와 같은 보안 약점을 log.error() 호출로 대체하는 실제 코드 수정 사례를 보여주며, 로깅 표준 준수의 중요성을 강조합니다. 📝
- 코드 수정 전후 테스트 필수: 코드 수정 전 기존 테스트를 실행하여 기능 동작을 확인하고, 수정 후에도 다시 테스트를 수행하여 변경 사항이 올바르게 적용되었는지 검증하는 과정을 시연합니다. ✅
- 일관된 코드 포맷팅 및 주석: Eclipse의 'Save Actions'를 활용하여 코드 포맷팅 일관성을 유지하고, 개정 이력 및 개발 표준 가이드에 따른 주석 추가의 중요성을 설명합니다. 📏
- Git/GitHub를 통한 기여 과정: 새로운 브랜치 생성, 최신 변경사항 풀(pull), 커밋 메시지 작성, 푸시(push), 그리고 상세한 풀 리퀘스트(PR) 생성 과정을 통해 오픈소스 기여 절차를 안내합니다. 🚀
- Lombok
@Slf4j 활용 로거 개선: PMD 수정 외에, Lombok의 @Slf4j 어노테이션을 사용하여 로거 선언을 간소화하고, isErrorEnabled()와 같은 로깅 최적화 기법을 적용하는 추가 개선 사항을 보여줍니다. ✨
- 파라미터화된 로깅 및
.gitignore 관리: 더하기 연산 대신 파라미터화된 로깅 방식을 선호하고, PMD 실행 시 생성되는 불필요한 파일을 .gitignore에 추가하여 버전 관리에서 제외하는 팁을 제공합니다. 🗑️
- 지속적인 개선 및 기여 문화: PMD 진단 외에도 코드 품질을 높이기 위한 자발적인 개선 노력과 오픈소스 프로젝트에 대한 지속적인 기여 문화를 장려합니다. 💡