[Github] IntelliJ .gitignore 파일 설정

 

IntelliJ에서 개발을 하고 github에 commit 하면 다음과 같이 .idea 폴더와 .iml 파일이 같이 올라갑니다.

하지만 .idea 폴더와 .iml 파일은 github에 commit 할 때 ignore 해주어야 합니다.

 

.idea 폴더

.idea 폴더는 IntelliJ IDEA에서 사용하는 프로젝트 설정 폴더입니다. 이 폴더에는 개발 환경 설정, 코드 스타일, 런타임 구성, 버전 관리 시스템 설정 등 프로젝트에 필요한 다양한 설정 파일들이 저장됩니다. 각 개발자가 선호하는 IDEA 설정이 다를 수 있으므로, 이 폴더의 내용은 사용자마다 상이할 수 있습니다.

<!--misc.xml-->
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
  <component name="ProjectRootManager" version="2" languageLevel="JDK_17" default="true" project-jdk-name="17" project-jdk-type="JavaSDK">
    <output url="file://$PROJECT_DIR$/out" />
  </component>
</project>

<!--modules.xml-->
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
  <component name="ProjectModuleManager">
    <modules>
      <module fileurl="file://$PROJECT_DIR$/gaonnuri-baseball.iml" filepath="$PROJECT_DIR$/gaonnuri-baseball.iml" />
    </modules>
  </component>
</project>

<!--vcs.xml-->
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
  <component name="VcsDirectoryMappings">
    <mapping directory="$PROJECT_DIR$" vcs="Git" />
  </component>
</project>

 

 

.iml 파일

.iml 파일은 IntelliJ 프로젝트의 모듈을 정의하는 파일로, XML 형식으로 되어 있습니다. 이 파일에는 모듈의 이름, 사용된 라이브러리, 컴파일러 옵션 등 모듈에 대한 구성 정보가 담겨 있습니다. 프로젝트 내의 각각의 모듈마다 .iml 파일이 존재할 수 있습니다.

 

 

.gitignore 파일에 .idea, .iml을 제외하는 이유

1. 환경 특화성

.idea 폴더와 .iml 파일은 개발자의 개인적인 환경 설정을 반영합니다. 프로젝트 팀 내에서 다른 설정을 사용하는 경우가 많으므로, 이를 공유하면  프로젝트 설정 충돌이 발생할 수 있습니다.

 

2. 프로젝트의 일관성

프로젝트 설정 파일을 공유하지 않음으로써 모든 팀원이 동일한 프로젝트 구조를 유지할 수 있도록 합니다. 이를 통해 새로운 팀원이 프로젝트에 참여할 때 설정의 불일치로 인한 문제를 최소화 할 수 있습니다.

 

3. 버전 관리의 깔끔함

불필요한 설정 파일을 제외함으로써, 프로젝트 변경 사항 추적을 보다 명확하고 관리하기 쉽게 만듭니다. 이는 특히 큰 프로젝트나 다수의 개발자가 함께 작업하는 환경에서 중요합니다.

 

 

 

 

---

 

해당 글은 공부 차원에서 다음의 블로그 글을 재 작성 한 것 입니다.

 

 

https://honey-dev.com/%EC%9D%B8%ED%85%94%EB%A6%AC%EC%A0%9C%EC%9D%B4-gitignore-%ED%8C%8C%EC%9D%BC-%EC%84%A4%EC%A0%95-%EC%8B%9C-idea%EC%99%80-iml%EC%9D%84-%EC%99%9C-%EC%A0%9C%EC%99%B8%ED%95%98%EB%82%98%EC%9A%94/

인텔리제이 .gitignore 파일 설정 시 .idea와 .iml을 왜 제외하나요? | 꿀발자