한국어 | English
안녕하세요, 기여에 관심을 가져주셔서 감사합니다.🙇♂️ 오픈 소스는 저 하나만이 아닌, 여러분들이 함께 만들어가는 공간입니다! 여러분들의 기여가 오픈 소스를 더욱 빛나게 만듭니다.
바나나Bananass, 🍌🍌🍌🍌 프레임워크는 오픈소스 개발 뿐만 아니라, 바나나 프레임워크를 통한 백준 문제 풀이 및 해설 역시 커뮤니티의 일환으로 기여를 받고 있습니다. 바나나 프레임워크 리포지토리상에 존재하는 모든 코드에 여러분들은 기여할 수 있지만, 이 중 가장 대표적인 내용들은 아래와 같습니다.
- 문서 기여: '바나나 프레임워크를 이용한 백준 문제 풀이 및 해설', '바나나 프레임워크 웹사이트 문서', '
README.md' 등등... - 웹사이트 기여: '웹사이트 디자인', '버그 수정', '기능 제안' 등등...
- 코드 기여: '코드 커버리지를 채우지 못한 부분에 대한 테스트 코드 추가', '버그 수정', '기능 제안' 등등...
??: (귀여운 바나나 프레임워크 배너와 favicon 등으로 사용할 수 있는 이미지를 보내주시면,README.md의 'Special Thanks to'에 이름을 올려드립니다...!🙇♂️)
프로젝트 전체에 걸쳐 준수해야 하는 규칙은 아래와 같습니다.
- 마크다운 문서(
**/*.md)를 제외한 모든 코드 및 내부 주석들은 반드시 영문으로 작성되어야 합니다. LICENSE.md및CHANGELOG.md를 제외한 모든 마크다운 문서들은 반드시 한글 문서(.md)와 영문 문서(.en.md) 2가지 종류를 작성해야 합니다.
만약, 여러분들이 오픈 소스에 첫 발을 내딛었거나, 오픈 소스 여정을 시작한지 얼마 안되었다면 현재 가이드를 읽는 것이 많은 도움이 될 것입니다. 만약 아니라면, 지금 바로 다음 단계로 넘어가셔도 좋습니다! 아래의 내용들은 비단 바나나 프레임워크 뿐만 아닌, 모든 오픈 소스 프로젝트에 범용적으로 적용되는 내용입니다.
기여를 하고 싶은데, 과연 어디서 부터 손을 대야 할까요? 기여는 여러분이 소프트웨어를 이용하며 느끼는 사소할 수도 있는 불편함으로 부터 시작합니다.
대부분의 오픈 소스 프로젝트의 기여는 문서 기여로 부터 시작합니다. 문서에는 개발자가 오랜시간 고안한 기능들이나 사용법, 구조 그리고 프로젝트의 목적 등이 담겨 있습니다. 문서를 통해 프로젝트를 더욱 깊고 넓게 이해할 수 있습니다.
바나나 프레임워크의 문서를 읽다 오탈자를 발견하셨나요? 오탈자를 고치는게 좋겠다면, 지금 바로 오탈자를 수정해서 끌어오기 요청Pull Request을 보내보세요! 끌어오기 요청이 어렵거나 혹은 번거롭다고요? 그럼 이슈Issue를 작성하여 오탈자를 알려주시는 것만으로도 오픈 소스에 큰 도움이 됩니다!
또는, 바나나 프레임워크의 문서가 여러분이 이해하기 어렵다고 느껴진다면, 문서를 수정하거나 추가하여 더욱 명확하게 만들어보세요. 혼자만의 불편함이 아닌 사용자 모두가 공통적으로 느끼고 있는 불편함일 수도 있습니다!
혹은, 미번역된 문서 번역 등을 통해 더 넓은 커뮤니티에 도움을 주세요! 바나나 프레임워크는 한글과 영문 문서를 모두 지원하고 있어, 여러분의 기여를 통해 더 많은 사람들이 바나나 프레임워크를 이용할 수 있습니다.
바나나 프레임워크는 npm workspaces와 lerna를 이용한 모노레포monorepo 구조를 사용합니다.