Github README

죽난
|2024. 7. 2. 10:12

나는 평소에 개발한 것을 github에 올릴 때 private으로 올리거나 README 작성을 소홀히 하고 올렸다. Github를 그냥 나만의 개인 공간이라고 생각하면서 올리는 경우가 많기도 했고 여러 대의 PC를 사용할 때 코드를 편하게 공유하기 위함이 컸다.

 

최근에 Denoising Diffusion Probabilistic Models 논문을 읽고서 Github에 올라와 있는 코드를 실행하다가 오류를 수정하고 Pull Request 하여 Contributors로 등록이 되었다. 오랜 시간 개발을 해왔지만 오픈 소스에 기여한 것은 처음이었고 사소한 오류를 수정했지만, 이 경험은 나에게 큰 자부심을 안겨주었다.

 

내 Github를 보면 정리되지 않은 Repository가 많아 어떤 코드를 짠 건지 다시 봐야하는 경우가 많고 코드 재사용하는 경우가 드물다.

 

https://meetup.nhncloud.com/posts/141

 

3년 된 오픈소스가 1주일 만에 3,000 GitHub 스타를 받다 : NHN Cloud Meetup

3년 된 오픈소스가 1주일 만에 3,000 GitHub 스타를 받다

meetup.nhncloud.com

 

“그저 소스를 공개했다고 오픈소스가 되지는 않는다.” 위 포스트를 보면서 당연했지만 망각하고 있던 말인 것 같다. README에 중요성도 알게 되었고 많은 star도 받아보고 싶다는 생각이 들었다. 여러 사람이 내 코드에 Issue를 남기고 관심을 갖는다면 그것 또한 동기부여가 될 거 같다.

 

앞으로 만드는 repository들에는 README에도 신경을 써봐야겠다.

'회고록' 카테고리의 다른 글

AI 연구에서 엔지니어링 스킬  (0) 2024.08.13