From 6412746b919321869b6f2afc449b25424a37028c Mon Sep 17 00:00:00 2001 From: yongfire38 Date: Fri, 24 Mar 2023 13:54:06 +0900 Subject: [PATCH] =?UTF-8?q?Doc:=20=EC=98=81=EB=AC=B8=20=EC=B6=94=EA=B0=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/ISSUE_TEMPLATE/amendment_request.yml | 24 ++++----- .github/ISSUE_TEMPLATE/bug_report.yml | 52 ++++++++++---------- .github/ISSUE_TEMPLATE/feature_request.yml | 36 +++++++------- .github/pull_request_template.md | 37 +++++++------- 4 files changed, 73 insertions(+), 76 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/amendment_request.yml b/.github/ISSUE_TEMPLATE/amendment_request.yml index d609a79d..da2125d2 100644 --- a/.github/ISSUE_TEMPLATE/amendment_request.yml +++ b/.github/ISSUE_TEMPLATE/amendment_request.yml @@ -1,5 +1,5 @@ -name: 개발가이드 수정 요청 -description: 개발가이드 수정 요청하는 템플릿입니다. +name: 개발가이드 수정 요청 Requesting changes to the development guide +description: 개발가이드 수정 요청하는 템플릿입니다. Template for requesting changes to the dev guide. title: "[Guide]: " labels: ["guide"] assignees: @@ -8,28 +8,28 @@ body: - type: markdown attributes: value: | - 시간을 내어 개발가이드 수정 요청을 작성해 주셔서 감사합니다. (공유하고 싶은 기술문서나 노하우는 github wiki에 남겨 주세요.) + 시간을 내어 개발가이드 수정 요청을 작성해 주셔서 감사합니다. Thank you for taking the time to fill out a DevGuide correction request. (공유하고 싶은 기술문서나 노하우는 github wiki에 남겨 주세요. If you have any documentation or know-how you'd like to share, please leave it on our github wiki.) - type: input id: url attributes: - label: 개발가이드 URL - description: 수정해야할 개발가이드 URL을 적어 주세요. - placeholder: 예) https://www.egovframe.go.kr/wiki/doku.php?id=egovframework:rte4.1:fdl:aop:aspectj + label: 개발가이드 URL Dev Guide URL + description: 수정해야할 개발가이드 URL을 적어 주세요. Please write down the dev guide URL that needs to be modified. + placeholder: Example) https://www.egovframe.go.kr/wiki/doku.php?id=egovframework:rte4.1:fdl:aop:aspectj validations: required: true - type: textarea id: where-to-amend attributes: - label: 수정 대상 내용 - description: 수정해야할 대상 내용을 기입해 주세요. - placeholder: 수정해야할 대상은 다음과 같습니다. + label: 수정 대상 내용 What to fix + description: 수정해야할 대상 내용을 기입해 주세요. Fill in what you need to fix. + placeholder: 수정해야할 대상은 다음과 같습니다. Here's what you'll need to modify validations: required: true - type: textarea id: amendment attributes: - label: 수정 문구 - description: 어떻게 수정되어야 하는지 적어주세요. - placeholder: 다음과 같이 수정되어야 합니다. + label: 수정 문구 Corrective Wording + description: 어떻게 수정되어야 하는지 적어주세요. Please write down how it should be fixed. + placeholder: 다음과 같이 수정되어야 합니다. It should be modified as follows validations: required: true diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 196e390b..74cf566d 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,5 +1,5 @@ -name: 버그 리포트 -description: 오류 내용을 이슈로 등록하는 템플릿입니다. +name: 버그 리포트 Bug report +description: 오류 내용을 이슈로 등록하는 템플릿입니다. Template to register an error as an issue. title: "[Bug]: " labels: ["bug", "triage"] assignees: @@ -8,55 +8,55 @@ body: - type: markdown attributes: value: | - 시간을 내어 버그 리포트를 작성해 주셔서 감사합니다. + 시간을 내어 버그 리포트를 작성해 주셔서 감사합니다. Thank you for taking the time to fill out a bug report. - type: input id: contact attributes: - label: 연락처 - description: 추가 정보 필요 시, 연락할 수 있는 이메일을 적어 주세요. (옵션) + label: 연락처 Contact + description: 추가 정보 필요 시, 연락할 수 있는 이메일을 적어 주세요. Please include an email where we can reach you if we need more information. (Optional) placeholder: 예) email@example.com validations: required: false - type: textarea id: what-happened attributes: - label: 오류 내용 - description: 오류 내용을 기입해 주세요. + label: 오류 내용 Error Description + description: 오류 내용을 기입해 주세요. Please provide a description of the error. placeholder: Tell us what you see! - value: "오류를 발견했어요." + value: "오류를 발견했어요. I found an error." validations: required: true - type: textarea id: reproduce attributes: - label: 오류 재현 방법 - description: 오류 발생을 재현하려면, 어떻게 해야하나요? - placeholder: 오류 재현 방법 - value: "(다음은 예시이며, 내용을 덮어 써 주세요.)\n\n -1. 다음 메뉴를 선택한다. '...'\n -2. 다음 버튼을 클릭한다. '....'\n -3. 다음 문구까지 스크롤 다운한다. '....'\n -4. 오류를 확인한다." + label: 오류 재현 방법 How to reproduce the error + description: 오류 발생을 재현하려면, 어떻게 해야하나요? How can we reproduce the error you reported? + placeholder: 오류 재현 방법 How to reproduce the error + value: "(다음은 예시이며, 내용을 덮어 써 주세요. The following is an example, please overwrite the content.)\n\n +1. 다음 메뉴를 선택한다. Select the following menu '...'\n +2. 다음 버튼을 클릭한다. Click the Next button. '....'\n +3. 다음 문구까지 스크롤 다운한다. Scroll down to the following phrase '....'\n +4. 오류를 확인한다. Check for errors." validations: required: false - type: textarea id: environment attributes: - label: 환경정보 - description: 오류가 발생한 환경정보를 작성해 주세요. - placeholder: 오류 환경정보 - value: " - OS정보: \n -- 표준프레임워크 버전: \n + label: 환경정보 Environmental Information + description: 오류가 발생한 환경정보를 작성해 주세요. Please describe the environment in which the error occurred. + placeholder: 오류 환경정보 Error Environment Information + value: " - OS정보 Operating System: \n +- 표준프레임워크 버전 eGovFrame Version: \n - JDK(JRE) 정보: \n - WAS 정보: \n - DB 정보: \n -- 기타 환경 정보:" +- 기타 환경 정보 Other environmental information:" validations: required: false - type: dropdown id: browsers attributes: - label: 어느 브라우저를 사용했나요? + label: 어느 브라우저를 사용했나요? Which browser did you use? multiple: true options: - Chrome @@ -65,10 +65,10 @@ body: - Opera - Safari - Internet Explorer - - 기타 + - Others - type: textarea id: logs attributes: - label: 에러 로그 - description: 관련 에러 로그를 복사하여 붙여넣어 주세요. + label: 에러 로그 Error Logs + description: 관련 에러 로그를 복사하여 붙여넣어 주세요. Please copy and paste the relevant error logs. render: shell diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 1a1716d3..fd59ab43 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -1,6 +1,6 @@ -name: 기능 요구 및 의견 -description: 기능 요구나 기타 의견을 이슈로 등록하는 템플릿입니다. -title: "[기능요구]: " +name: 기능 요구 및 의견 Feature Request +description: 기능 요구나 기타 의견을 이슈로 등록하는 템플릿입니다. Suggest an idea for improving eGovFrame. +title: "[기능요구(Feature)]: " labels: ["feature"] assignees: - jei007 @@ -8,44 +8,44 @@ body: - type: markdown attributes: value: | - 시간을 내어 의견을 작성해 주셔서 감사합니다. + 시간을 내어 의견을 작성해 주셔서 감사합니다. Thank you for taking the time to fill out a request. - type: input id: contact attributes: - label: 연락처 - description: 추가 정보 필요 시, 연락할 수 있는 이메일을 적어 주세요. (옵션) + label: 연락처 Contact + description: 추가 정보 필요 시, 연락할 수 있는 이메일을 적어 주세요. Please include an email where we can reach you if we need more information. (Optional) placeholder: 예) email@example.com validations: required: false - type: input id: feature-title attributes: - label: 추가 요청 기능명 - description: 추가를 원하는 기능명칭을 간략히 적어주세요. - placeholder: 예) 게시판 첨부기능 추가 + label: 추가 요청 기능명 Feature Name + description: 추가를 원하는 기능명칭을 간략히 적어주세요. Write the title of the feature you'd like to add. + placeholder: 예) 게시판 첨부기능 추가 Example) Adding a bulletin board attachment validations: required: true - type: textarea id: feature-request-details attributes: - label: 기능 상세 설명 - description: 추가를 원하는 기능에 대해 상세히 기술해 주세요. - placeholder: 추가를 원하는 기능은 다음과 같습니다. + label: 기능 상세 설명 Feature Description + description: 추가를 원하는 기능에 대해 상세히 기술해 주세요. Please describe in detail the features you would like to see added. + placeholder: 추가를 원하는 기능은 다음과 같습니다. Here are the features I'd like to see added validations: required: true - type: textarea id: solution attributes: - label: 솔루션 상세 - description: 위 기능을 구현하는데 도움이 되는 기술내용이 있으면 적어 주세요. - placeholder: 위 기능을 구현하는데 도움이 되는 기술내용은 다음과 같습니다. + label: 솔루션 상세 Solution Details + description: 위 기능을 구현하는데 도움이 되는 기술내용이 있으면 적어 주세요. If you have any technical details to help us implement the above features, please let us know. + placeholder: 위 기능을 구현하는데 도움이 되는 기술내용은 다음과 같습니다. Here are some technical details to help you implement the above features. validations: required: false - type: input id: solution-url attributes: - label: 솔루션 관련 URL - description: 위 기능을 구현하는데 도움이 되는 웹사이트 주소가 있으면 적어 주세요. - placeholder: 예) egovframe.go.kr + label: 솔루션 관련 URL Solution-related URLs + description: 위 기능을 구현하는데 도움이 되는 웹사이트 주소가 있으면 적어 주세요. If you have a website address that can help us implement the above features, please write it down. + placeholder: Example) egovframe.go.kr validations: required: false diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 68ad309b..2c5e9b22 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,29 +1,26 @@ -## 수정 사유 +## 수정 사유 Reason for modification -소스를 수정한 사유가 무엇인지 체크해 주세요. ([X] X는 대문자여야 합니다.) +소스를 수정한 사유가 무엇인지 체크해 주세요. Please check the reason you modified the source. ([X] X는 대문자여야 합니다.) -- [X] 버그수정 -- [ ] 기능개선 -- [ ] 기능추가 -- [ ] 기타 +- [x] 버그수정 Bug fixes +- [ ] 기능개선 Enhancements +- [ ] 기능추가 Adding features +- [ ] 기타 Others +## 수정된 소스 내용 Modified source -## 수정된 소스 내용 +검토자를 위해 수정된 소스 내용을 설명해 주세요. Please describe the modified source for reviewers. -검토자를 위해 수정된 소스 내용을 설명해 주세요. +## JUnit 테스트 JUnit tests +테스트를 완료하셨으면 다음 항목에 [대문자X]로 표시해 주세요. When you're done testing, check the following items. -## JUnit 테스트 +- [x] JUnit 테스트 JUnit tests +- [x] 수동 테스트 Manual testing -테스트를 완료하셨으면 다음 항목에 [대문자X]로 표시해 주세요 +## 테스트 브라우저 Test Browser -- [X] JUnit 테스트 -- [X] 수동 테스트 - - -## 테스트 브라우저 - -테스트를 진행한 브라우저를 선택해 주세요. (다중 선택 가능) [X] X는 대문자여야 합니다. +테스트를 진행한 브라우저를 선택해 주세요. Please select the browser(s) you ran the test on. (다중 선택 가능 you can select multiple) [X] X는 대문자여야 합니다. - [ ] Chrome - [ ] Firefox @@ -31,8 +28,8 @@ - [ ] Safari - [ ] Opera - [ ] Internet Explorer -- [ ] 기타 +- [ ] 기타 Others -## 테스트 스크린샷 또는 캡쳐 영상 +## 테스트 스크린샷 또는 캡쳐 영상 Test screenshots or captured video -테스트 전과 후의 스크린샷 또는 캡쳐 영상을 이곳에 첨부해 주세요. +테스트 전과 후의 스크린샷 또는 캡쳐 영상을 이곳에 첨부해 주세요. Please attach screenshots or video captures of your before and after tests here.