콘텐츠로 이동

기여 방법

Discord에만 올라온 해결책은 사라집니다. 여기에 추가하면 검색 가능하고, 버전 관리되며, 같은 문제를 겪는 다음 사람이 더 쉽게 찾을 수 있습니다.

쉬운 기여 방법

1. GitHub에서 편집 (Git 지식 불필요)

  1. 페이지 상단 오른쪽의 편집 아이콘(✏️) 클릭
  2. GitHub 편집기에서 변경
  3. "Propose changes" → "Create pull request" 클릭

검토 후 병합합니다.

2. 이슈 보고

잘못된 정보나 누락된 정보를 발견했나요?

이슈 열기 →

다음을 알려주세요: - 무엇이 잘못되었거나 누락되었는지 - 대신 어떤 내용이 있어야 하는지 - 관련 링크나 출처

3. 구성 공유

BC250이 잘 작동하나요? 설정을 공유해 주세요:

하드웨어: - 어떤 PSU가 작동하는지? - 어떤 쿨러가 온도를 잘 유지하는지? - 디스플레이 어댑터 호환성?

소프트웨어: - 배포판 설정 단계 - 작동하는 kernel 버전 - 사용하는 BIOS 설정 - 테스트한 게임

관련 페이지에 추가하세요!

가장 유용한 기여

다음 사람이 문제를 더 빨리 해결하는 데 도움이 되는 모든 것:

  • 게임 호환성 보고 (FPS, 설정, 알려진 이슈)
  • 실제로 사용한 문제 해결 방법
  • 작동하는 하드웨어 (PSU, 쿨러, 디스플레이, 어댑터)
  • 아직 문서화되지 않은 배포판 가이드
  • 특정 용례를 위한 BIOS 설정
  • 구성에 대한 벤치마크 결과
  • 오타 수정, 더 명확한 설명, 누락된 명령
  • 스크린샷, 다이어그램, dmesg 또는 센서 캡처

하지 말아야 할 것

  • 검증되지 않은 주장이나 추측 추가. 테스트하지 않았다면 "reportedly"라고 하고 출처를 인용하세요.
  • 독점 BIOS 파일이나 저작권 콘텐츠 복사.
  • 관련 없는 변경을 하나의 PR에 혼합.

기여 예시

예시: 게임 호환성 추가

docs/gaming/compatibility.md 편집:

### Elden Ring

**Status:** ✅ Playable
**Performance:** 55-60 FPS @ 1080p High
**VRAM:** 512MB dynamic recommended
**Settings:**
- Graphics: High
- Anti-aliasing: Medium
- RADV_DEBUG=nocompute %command%

**Notes:**
- Stuttering in some areas with 8GB/8GB split
- Smooth with 512MB dynamic VRAM

예시: 문제 해결 방법 추가

docs/troubleshooting/boot.md 편집:

### Black Screen After Mesa Update

**Symptoms:**
- System boots but no display
- SSH still works

**Solution:**
Downgrade Mesa to last working version:

```bash
sudo dnf downgrade mesa-vulkan-drivers mesa-dri-drivers

Then report the issue to Mesa GitLab. 

### 예시: 하드웨어 호환성 추가

`docs/hardware/power.md` 편집:

```markdown
### Tested PSUs

**Corsair SF450 (450W SFX)**
- ✅ Works perfectly
- Tested with RTX 3060 Ti (TDP mod)
- No stability issues
- Tested by: @username

고급: 로컬 개발

변경 사항을 로컬에서 미리 보려면?

# Clone repository
git clone https://github.com/elektricM/amd-bc250-docs.git
cd amd-bc250-docs

# Install MkDocs
pip install mkdocs-material

# Preview locally
mkdocs serve
# Open http://127.0.0.1:8000/

전체 가이드: GitHub의 CONTRIBUTING.md

문서 구조

기여를 추가할 위치:

docs/
├── getting-started/     # First-time setup, prerequisites
├── hardware/           # Specs, power, cooling, displays
├── bios/              # BIOS flashing, VRAM, overclocking
├── linux/             # Distribution-specific guides
├── drivers/           # RADV driver, environment variables
├── system/            # GPU governor, sensors, power
├── gaming/            # Game compatibility, performance
├── troubleshooting/   # Common problems and solutions
└── reference/         # Quick references, cheatsheets

Pull Request 가이드라인

문서를 검토 가능하게 하고 커밋 히스토리를 읽기 쉽게 유지하는 관례.

커밋 메시지

타입 접두사가 있는 짧은 한 줄 제목, 빈 줄, 변경 내용과 이유를 설명하는 본문.

허용 접두사, 소문자, 하위 범위 없음:

  • docs: 문서 추가 또는 편집
  • fix: 오류 또는 오래된 정보 수정
  • feat: 새 사이트 기능 (테마 오버라이드, 플러그인, nav 변경)
  • chore: 리팩터링, 의존성 업데이트, 비기능적 mkdocs.yml 정리

예시:

  • docs: add Alpine Linux setup guide
  • fix: correct VRAM pages_limit value in Fedora CoreOS guide
  • chore: bump mkdocs-material to 9.5

PR당 하나의 변경

각 PR은 하나의 논리적 변경에 집중하세요. 오타 수정과 새 배포판 가이드는 두 개의 PR이어야 합니다. 혼합 PR은 검토가 느리고 되돌리기 어렵습니다.

하드웨어 검증된 주장

명령, 파라미터, kernel 옵션, 또는 BIOS 설정을 추가할 때는 BC-250에서 먼저 실행하고 결과를 확인하세요. 실제 출력(sensors, dmesg, 벤치마크 점수)이 요약보다 낫습니다.

출처 인용

명확하지 않은 주장(성능 수치, kernel 버전 요구 사항, "X MHz까지 안정적")에는 정보 출처를 밝히세요: 자체 벤치, Discord 스레드, upstream kernel 커밋. 미확인 주장은 "reportedly"로 표시하면 됩니다.

중복하지 말고 교차 참조

단계가 다른 곳에 이미 문서화되어 있으면(governor 설정, BIOS 플래싱, kernel 선택) 단계를 복사하지 말고 해당 페이지로 링크하세요. 사이트 유지보수가 쉬워집니다.

PR 제목과 커밋 제목 일치

PR 제목과 커밋 제목에 같은 줄을 사용하세요. PR에 여러 커밋이 있고 squash-merge하는 경우, 해당 제목이 병합된 커밋이 됩니다.

검토 프로세스

  1. PR 제출
  2. 자동 검사로 사이트 빌드 확인
  3. 유지보수자 검토 (보통 48시간 이내)
  4. 변경이 필요하면 피드백
  5. 병합, https://elektricM.github.io/amd-bc250-docs/ 자동 게시

질문?

  • 어떻게...? CONTRIBUTING.md 읽기
  • 버그 발견? 이슈 열기
  • 도움이 필요? Discord에 질문하되, 해결되면 여기에도 추가하세요!

기여 시작하기 →