diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..6ab880d --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,78 @@ +# 기여하기 + +## 이슈를 등록하기 전에 + +### 버그 + +먼저 지원하는 기기인지 확인합니다. + +#### 지원하지 않는 기기 + +```md +- 어떠한 확장프로그램 (AdBlock, Darkmode etc.) +- 브라우저: IE, Pre 17 Edge. +- Windows 7 이전의 Windows +- 10.10 버전 이하의 macOS +- 10.0 버전 이하의 iOS +- 5.0 버전 이하의 안드로이드 +- 3.5" 아이폰 +- 모든 VM +- 탈옥 또는 루팅된 기기 +- 공식 지원 종료된 모든 리눅스 버전 +- 보안 이슈 (보안과 관련된 문제는 비공개적이게 개발자에게 전달해주세요) +- 정식빌드에서는 발생하지 않는 Canary혹은 PTB와 같은 베타 버전의 브라우저/OS에서 발생하는 버그 +- 이외 개발자가 지원 종료 선언한 모든 플랫폼혹은 기기 +``` + +그 다음 이슈를 등록합니다. +[등록하기](https://github.com/koreanbots/koreanbots/issues/new/choose) + +**이슈에서는 빠른 소통을 위해 약자를 사용합니다.** +이슈를 보신다면 댓글을 남겨주세요. + +- `CR` **Can Reproduce** 의 약자로 재현 가능한 버그라는 뜻입니다. +- `CNR` **Can Not Reproduce** 의 약자로 재현이 불가능하다는 뜻입니다. +- `NAB` **Not a Bug** 의 약자로 버그에 해당하지 않는다는 뜻입니다. + +#### 승인과 거부 + +버그는 2개의 재현가능 여부에 대한 승인(Approve) 또는 거부(Deny)를 받게되면, 승인과 거부가 결정됩니다. + +##### 승인 + +버그가 재현 가능하다고 2명 이상의 유저에게 승인이 된다면, 해당 버그는 개발자의 확인을 기다리며, `approved` 라벨을 획득합니다. + +##### 거부 + +버그가 재현 가능하지않다고 2명 이상의 유저에게 거부가 된다면, 해당 버그는 `deny` 라벨을 획득하며, 이슈는 `Closed` 처리됩니다. + +### 제안 + +제안은 [Discussions](https://github.com/koreanbots/koreanbots/discussions)에서 자유롭게 해주세요! + +## 관리 + +이슈는 관리자와 버그 헌터분들이 관리합니다. + +### 버그 헌터란? + +버그 헌터는 버그를 열심히 찾아주시거나, 해당 레포지토리에 활발하게 참여하여, 특정 기준 이상을 참여해주신 유저분들에게 지급해드리는 권한입니다. + +버그헌터는 이슈를 닫거나, 라벨을 추가할 수 있으며 `Approve`와 `Deny`와 같은 상태를 관리합니다. + +### 처벌 + +이슈에서 장난식 발언을 하거나, 관련성이 없는 말 또는 스팸을 게시한다면, 통보없이 처벌되실 수 있습니다. + +## 기여 + +기여는 언제든 환영입니다 커밋메세지는 다음 규칙을 따라주시면 감사하겠습니다! + +[Conventional Commits](https://www.conventionalcommits.org/ko/v1.0.0/) + +--- + +### 기존 레포들 + +- [client](https://github.com/koreanbots/client) +- [api](https://github.com/koreanbots/api) diff --git a/.github/assets/koreanbots-en.png b/.github/assets/koreanbots-en.png new file mode 100644 index 0000000..fef99f6 Binary files /dev/null and b/.github/assets/koreanbots-en.png differ diff --git a/.github/assets/koreanbots-ko.png b/.github/assets/koreanbots-ko.png new file mode 100644 index 0000000..6f193a4 Binary files /dev/null and b/.github/assets/koreanbots-ko.png differ diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000..2ecfcba --- /dev/null +++ b/README.en.md @@ -0,0 +1,84 @@ +# koreanbots +![Logo](././.github/assets/koreanbots-ko.png) + +![Tests](https://github.com/koreanbots/koreanbots/workflows/Tests/badge.svg) +![Deploy](https://github.com/koreanbots/koreanbots/workflows/Deploy/badge.svg) +[![DeepScan grade](https://deepscan.io/api/teams/12468/projects/15503/branches/310734/badge/grade.svg)](https://deepscan.io/dashboard#view=project&tid=12468&pid=15503&bid=310734) + +> Korean Discord Bots in one place. + +## SNS + +- [Twitter](https://twitter.com/koreanbots) +- [Instagram](https://instagram.com/koreanbots) + +## Contact + +- [개발자 이메일](mailto:wonderlandpark@callisto.team) +- [디스코드](https://discord.gg/JEh53MQ) + +## Contributing + +Issues and PRs are always welcomed. + +### Before submitting an Issue + +#### Bug + +First, check if the device supports it. + +#### Devices not supported + +```md +- Any extension program (AdBlock, Darkmode etc.) +- Browser: IE, Pre 17 Edge. +- Windows prior to Windows 7 +- MacOS version 10.10 or lower +- iOS version 10.0 or lower +- Android version 5.0 or lower +- 3.5" iPhone +- All VMs +- Jailbroken or rooted device +- All Linux versions that have ended official support +- Security issues (Please forward security-related issues to the developer privately) +- Bugs that do not occur in the official build, occur in the browser/OS of beta versions such as Canary or PTB +- All platforms or devices that other developers have declared end of support +``` + +Then register the issue. +[Submit](https://github.com/koreanbots/koreanbots/issues/new/choose) + +If you see an issue, please leave a comment like these. + +- `CR` Means **Can Reproduce** +- `CNR` Means **Can Not Reproduce** +- `NAB` Means **Not a Bug** + +#### Approval and deny + +When a bug receives two reproducible approvals or denial, the approval and rejection are decided. + +##### Approve + +If a bug is approved by more than two user as reproducible, the bug waits for confirmation from the developer and obtains a `approved` label. + +##### Deny + +If a bug is rejected by more than one user because it is not reproducible, the bug gets a `deny` label and the issue is `Closed`. + +#### 제안 + +Please feel free to make suggestions at [Discussions](https://github.com/koreanbots/koreanbots/discussions)! + +### Submit Pull Request + +Contributions are always welcome. We appreciate your commit messages if you follow the rules below! + +[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) + +--- + +### Old Repositories + +- [client](https://github.com/koreanbots/client) +- [api](https://github.com/koreanbots/api) diff --git a/README.md b/README.md index 29cfd95..db529f8 100644 --- a/README.md +++ b/README.md @@ -1,80 +1,27 @@ # koreanbots +![Logo](./.github/assets/koreanbots-en.png) + +![Tests](https://github.com/koreanbots/koreanbots/workflows/Tests/badge.svg) +![Deploy](https://github.com/koreanbots/koreanbots/workflows/Deploy/badge.svg) +[![DeepScan grade](https://deepscan.io/api/teams/12468/projects/15503/branches/310734/badge/grade.svg)](https://deepscan.io/dashboard#view=project&tid=12468&pid=15503&bid=310734) + +[Introduced in English](./README.en.md) + > 국내 디스코드봇을 한곳에서. -이슈와 기여는 언제든지 환영입니다. +## SNS -## 이슈를 등록하기 전에 +- [Twitter](https://twitter.com/koreanbots) +- [Instagram](https://instagram.com/koreanbots) -### 버그 +## 문의 -먼저 지원하는 기기인지 확인합니다. +- [개발자 이메일](mailto:wonderlandpark@callisto.team) +- [디스코드](https://discord.gg/JEh53MQ) -#### 지원하지 않는 기기 +## 기여하기 -```md -- 어떠한 확장프로그램 (AdBlock, Darkmode etc.) -- 브라우저: IE, Pre 17 Edge. -- Windows 7 이전의 Windows -- 10.10 버전 이하의 macOS -- 10.0 버전 이하의 iOS -- 5.0 버전 이하의 안드로이드 -- 3.5" 아이폰 -- 모든 VM -- 탈옥 또는 루팅된 기기 -- 공식 지원 종료된 모든 리눅스 버전 -- 보안 이슈 (보안과 관련된 문제는 비공개적이게 개발자에게 전달해주세요) -- 정식빌드에서는 발생하지 않는 Canary혹은 PTB와 같은 베타 버전의 브라우저/OS에서 발생하는 버그 -- 이외 개발자가 지원 종료 선언한 모든 플랫폼혹은 기기 -``` +이슈와 PR은 언제든지 환영입니다. -그 다음 이슈를 등록합니다. -[등록하기](https://github.com/koreanbots/koreanbots/issues/new/choose) - -**이슈에서는 빠른 소통을 위해 약자를 사용합니다.** -이슈를 보신다면 댓글을 남겨주세요. - -- `CR` **Can Reproduce** 의 약자로 재현 가능한 버그라는 뜻입니다. -- `CNR` **Can Not Reproduce** 의 약자로 재현이 불가능하다는 뜻입니다. -- `NAB` **Not a Bug** 의 약자로 버그에 해당하지 않는다는 뜻입니다. - -#### 승인과 거부 - -버그는 2개의 재현가능 여부에 대한 승인(Approve) 또는 거부(Deny)를 받게되면, 승인과 거부가 결정됩니다. - -##### 승인 - -버그가 재현 가능하다고 2명 이상의 유저에게 승인이 된다면, 해당 버그는 개발자의 확인을 기다리며, `approved` 라벨을 획득합니다. - -##### 거부 - -버그가 재현 가능하지않다고 2명 이상의 유저에게 거부가 된다면, 해당 버그는 `deny` 라벨을 획득하며, 이슈는 `Closed` 처리됩니다. - -### 제안 - -제안은 자유롭게 해주셔도 됩니다! - -## 관리 - -이슈는 관리자와 버그 헌터분들이 관리합니다. - -### 버그 헌터란? - -버그 헌터는 버그를 열심히 찾아주시거나, 해당 레포지토리에 활발하게 참여하여, 특정 기준 이상을 참여해주신 유저분들에게 지급해드리는 권한입니다. - -버그헌터는 이슈를 닫거나, 라벨을 추가할 수 있으며 `Approve`와 `Deny`와 같은 상태를 관리합니다. - -### 처벌 - -이슈에서 장난식 발언을 하거나, 관련성이 없는 말 또는 스팸을 게시한다면, 통보없이 처벌되실 수 있습니다. - -## 사이트 레포들 - -- [client](https://github.com/koreanbots/client) -- [api](https://github.com/koreanbots/api) - -### 기여 - -기여는 언제든 환영입니다 커밋메세지는 다음 규칙을 따라주시면 감사하겠습니다! - -[Conventional Commits](https://www.conventionalcommits.org/ko/v1.0.0/) \ No newline at end of file +[기여 규칙](./.github/CONTRIBUTING)