[발전 방안 제안(Improvement Plan)]: 표준프레임워크 GitHub 배지 활용 내용 개선 #197
Description
Idea name : 표준프레임워크 GitHub 배지 활용 내용 개선
Suggestion Background
현재 표준프레임워크 GitHub 배지 활용이 실제 용도와 다르게 사용되거나 링크 등 정보를 추가하도록 개선이 됐으면 좋겠습니다.
GitHub 배지는 프로젝트 정보, 상태를 시각적으로 빠르게 전달하는 아이콘으로
주로 README.md 파일에서 사용되며, 빌드 상태, 커버리지, 사용 언어, 기여도 등 프로젝트의 주요 지표를 한눈에 보여줍니다.
이를 통해 프로젝트의 신뢰도를 높이고 가독성을 향상시킬 수 있습니다.
일반적인 오픈소스 프로젝트에서 사용하는 용도와 같이 개선됐으면 좋겠습니다.
[오픈소스 프로젝트에서 사용 사례]
- 빌드 상태, 커버리지, 사용 언어 등 상태가 표시되어야 합니다.
- 빌드 상태는 실시간 빌드 상태를 보여줄 수 있어야 되고
- 커버리지는 현재 main branch 버전에 대상 커버리지
- 사용 언어는 해당 프로젝트에서 사용하는 버전을 명시하는 것이 일반적입니다.
다음 예제를 참고 부탁드립니다.
- Apache Airflow : https://github.com/apache/airflow
-> 각각 배지를 클릭해보면 배지별 용도를 확인할 수 있습니다.
- 각 배지 클릿 시 상세 정보 화면으로 이동 (Build Status 클릭 시)
- Apache Beam: https://github.com/apache/beam
-> maven 배지 클릭 시 해당 라이브러리 등록 정보로 이동
[표준프레임워크 실행환경 사용 배지]
- 표준프레임워크 실행환경 Repository : https://github.com/eGovFramework/egovframe-runtime/
- 해당 배지에 대한 링크 없음. 상세 정보를 제공하고 있지 않음
- 표준프레임워크 배지 클릭 시
[English]
Idea name: Improve the Usage of GitHub Badges in the Standard Framework
Suggestion Background
Currently, the use of GitHub badges in the standard framework needs improvement, as they are being used in ways that don’t align with their intended purpose.
GitHub badges are visual icons that quickly convey project information and status. They are typically placed in the README.md file and are used to highlight key project metrics such as build status, test coverage, programming languages, and contributions. These badges help improve readability and increase project credibility.
It would be great if their usage could be aligned with common practices in open-source projects.
[Common use cases in open-source projects]
Displaying build status, test coverage, programming languages, etc.
Build status should reflect the real-time state of the build.
Coverage should indicate the test coverage of the current main branch.
Programming languages should specify the versions used in the project.
Please refer to the following example:
Apache Airflow: https://github.com/apache/airflow
→ By clicking on each badge, you can see the specific purpose of each one.