Merge pull request #133 from Team-INSERT/docs/open-source

docs(open source): 오픈 소스 준비

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,38 @@
+Contributor Covenant Code of Conduct
+Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+    Using welcoming and inclusive language
+    Being respectful of differing viewpoints and experiences
+    Gracefully accepting constructive criticism
+    Focusing on what is best for the community
+    Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+    The use of sexualized language or imagery and unwelcome sexual attention or advances
+    Trolling, insulting/derogatory comments, and personal or political attacks
+    Public or private harassment
+    Publishing others' private information, such as a physical or electronic address, without explicit permission
+    Other conduct which could reasonably be considered inappropriate in a professional setting
+
+Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+Attribution
+
+This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at http://contributor-covenant.org/version/1/4

.github/CONTRIBUTING.MD

@@ -0,0 +1,52 @@
+# BSM에 기여하기
+
+우리는 커뮤니티의 모든 사람의 기여를 환영합니다.<br/>
+이 레포지토리는 다양한 나라의 언어로 이루어지며, 한국어를 중심으로 이루어집니다.
+
+> BSM의 모든 기여자는 우리의 행동 강령을 준수해야 합니다.
+> <br/>어떤 행동이 허용되고 허용되지 않는지 이해하려면 [전체 내용](./CODE_OF_CONDUCT.md)를 읽어보시기 바랍니다 .
+
+## 1. 이슈
+
+다음을 통해 BSM에 기여할 수 있습니다 :
+
+- [버그 신고하기](https://github.com/Team-INSERT/bssm-frontend/issues/new/choose)
+- [새로운 기능 요청](https://github.com/Team-INSERT/bssm-frontend/issues/issues/new/choose)
+- [이미 있는 이슈를 보고](https://github.com/Team-INSERT/bssm-frontend/issues/issues) 수정해야 할 사항을 확인하세요.
+
+## 2. Pull Requests
+
+> [PR 시작하기](https://github.com/Team-INSERT/bssm-frontend/compare) <br/>
+
+나만의 PR을 올릴 수 있습니다. PR 제목은 다음 형식과 일치해야 합니다.
+
+```
+<commit keyword>(template scope): <description>
+
+ex) feat(calendar): 바 형식으로 조회하는 기능 추가
+```
+
+> 우리는 모든 PR을 메인에 병합하기 때문에 기록의 커밋 수나 스타일에 신경 쓰지 않습니다.<br/>
+> 편안하다고 느끼는 스타일로 자유롭게 커밋해주세요.
+
+### commit keyword
+
+**유형은 다음 중 하나여야 합니다:**
+
+src 내 메인 로직을 포함하는 코드를 수정한 경우 :
+
+- feat - 새로운 기능 추가
+- fix - 새로운 기능을 추가하지 않은 수정사항
+
+src 내 메인 로직을 포함하는 코드를 수정하지 않은 경우 :
+
+- test - 테스트 코드를 작성하거나 변경한 경우
+
+그 외 :
+
+- chore - 기타 모든 것 ( 주석 추가 등등... )
+
+### 3. etc
+
+코드를 작성할 때 BSM이 추구하는 구조 자체를 건드리는 것은 유쾌하지 않습니다.  
+만약 더욱 가독성이 좋은 디렉터리 구조를 발견하셨다면 이슈로 제보해주세요.

.github/ISSUE_TEMPLATE/bug.yml

@@ -6,12 +6,12 @@ body:
     attributes:
       label: Describe
       description: |
-        버그 설명
+        버그에 대해서 설명해주세요!
       placeholder: |
-        나니모 나캇다
+        헤더가 깨지는 버그가 발생해요
 
   - type: textarea
     attributes:
       label: Additional
       description: |
-        추가로 할말
+        추가로 해주실 말씀이 있나요?

.github/ISSUE_TEMPLATE/todo.yml → .github/ISSUE_TEMPLATE/feature_request.yml

@@ -1,24 +1,24 @@
-name: "Todo"
-description: "할일이 있으신가요? 📗"
+name: "Feature"
+description: "추가할 일이 있으신가요? 📗"
 body:
   - type: textarea
     attributes:
       label: Describe
       description: |
-        할일에 관한 설명
+        추가할 일에 관한 설명
       placeholder: |
-        그거 제작
+        요구사항을 작성해주세요
 
   - type: textarea
     attributes:
       label: Work
       description: |
         [작업내용] 무슨 작업을 하셨나요?
       placeholder: |
-        그거
+        ~~이런 작업을 했습니다.
 
   - type: textarea
     attributes:
       label: Additional
       description: |
-        추가로 할말?
+        추가로 해주실 말씀이 있나요?

README.md

@@ -1,26 +1,22 @@
-## BSM
+# 학생 스마트 정보 관리 시스템 [BSM](https://newbsm.team-insert.com) · [![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/toss/slash/blob/main/LICENSE) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/toss/slash/blob/main/.github/CONTRIBUTING.md)
 
-## commit convention
+BSM은 [인서트](https://team-insert.com)에서 개발한 부산소마고 교내 학생 정보 관리 시스템입니다.  
+학생들은 한 서비스 내에서 마이스터 역량 인증제와 급식, 학사 일정 등 여러가지 학교와 관련된 정보들을 확인할 수 있습니다.
 
-feat : 새로운 기능 추가  
-fix : 버그 수정  
-docs : 문서 관련  
-style : 스타일 변경 (포매팅 수정, 들여쓰기 추가, …)  
-refactor : 코드 리팩토링  
-test : 테스트 관련 코드  
-build : 빌드 관련 파일 수정  
-ci : CI 설정 파일 수정  
-perf : 성능 개선  
-chore : 그 외 자잘한 수정
+## 기여하기
 
-## import convention
+BSM에는 인서트 팀의 멤버, 혹은 부산소마고 학생이 아니더라도 누구나 기여할 수 있습니다.  
+BSM에 기여하고 싶다고 생각하셨다면 아래 문서를 참고해주세요.
 
-1. React
-2. style
-3. asset
-4. constant
-5. hook
-6. store
-7. type
-8. interface
-9. components
+[CONTRIBUTING](./.github/CONTRIBUTING.md)
+
+## 라이선스
+
+MIT © Team. INSERT. [LICENSE](./LICENSE) 파일을 참고하세요.
+
+<a title="인서트" href="https://team-insert.com">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://team-insert.com/static/media/logo.fd2f3e70586278ea0e49f7a138595482.svg">
+    <img alt="인서트" src="https://team-insert.com/static/media/logo.fd2f3e70586278ea0e49f7a138595482.svg" width="50">
+  </picture>
+</a>