Readme 파일 작성방법
안녕하세요 강사님 좋은 강의 감사드립니다.
readme파일을 잘 작성하는 것도 과제전형을 진행하는데 중요한 요소라고 들었는데
예제 소스에 작성된 readme 파일 형식으로 실제 과제전형 시에 제출하기에는 조금 부족해보이는데
보통 어떤 형식으로 작성하시는 편이신가요? 또는 이 부분은 꼭 들어갔으면 하는 요소가 있을까요?
답변 1
2
안녕하세요 걈쟈님~ 질문 남겨주셔서 감사합니다 ☺
README 파일 은 프로젝트가 무엇을 하는지, 어떻게 사용할 수 있는지, 그리고 필요한 설정이나 설치 방법 등을 빠르게 이해할 수 있도록 적는것이 좋습니다.
과제제출시 명확한 README 요구사항이 없다면 임의로 작성하셔도 무방합니다. 다만 시스템구조 도식이 들어가면 더 좋을듯합니다. README 작성법에 대한 내용을 조금 더 보강하여 섹션5. 면접대비 - 작업검토 강의의 수업노트에 올려두었으니 참고부탁드립니다. 추가적인 질문이 있다면 편하게 남겨주세요 🙏
NaverBookRepository.class 의 위치에 따른 모듈간의 의존성에 대해 질문드립니다.
1
31
2
패키지 vs 모듈 선택 기준
0
51
2
Kotlin 테스트 프레임워크
0
82
2
import 오류?
0
71
2
JSON 역직렬화
0
65
2
Spring Cloud 버전 관리 문제
0
270
2
AsyncExcutor 설정값 질문
0
82
2
17강 api서버구현2 질문있습니다.(ai답변이 이상합니다.)
0
117
2
16강 api서버구현 질문있습니다.
0
77
2
14번쨰 부분 중 질문드립니다..<ai답변으로 해도 안되요>
0
144
2
.
0
144
1
서비스에 @Transactional 애노테이션을 사용하시지 않는 이유가 궁금합니다
0
156
2
NaverClientTest 질문있습니다.
0
179
2
멀티모듈 구성 질문입니다.
0
209
3
멀티모듈 구성 강의에 대해 질문이 있습니다.
0
214
3
SPOCK 의존성 추가 후 Generate Test 옵션 미노출
0
202
3
멀티모듈 지식 습득에 관하여 질문 드립니다.
0
250
2
Async Config 테스트컨트롤러의 코드의 동작이 안되는거 같습니다.
0
223
3
author 배열이 비어서 오는 경우가 있으니 참고하세요.
0
190
3
커밋 끊으면서 해주시는거 너무 좋네요.
1
160
2
비즈니스 로직 담당 서비스
0
198
2
모의과제 소개
0
179
2
cqrs에 관하여
1
256
2
멀티모듈 문의드립니다.
0
264
2