MINARAMinara에 기여하기
올바른 확장 지점을 선택하고 개발 환경을 구성해 검토하기 쉬운 Pull Request를 만듭니다
Minara는 초점이 분명한 기여를 통해 성장합니다. 문장을 더 명확하게 다듬는 일, 더 안전한 도구를 만드는 일, 연구 스킬이나 멀티 Agent 흐름을 개선하는 일 모두 중요한 기여입니다. 실제 문제를 해결하는 가장 작은 변경부터 시작하고, 다른 사람이 확인할 수 있는 근거를 남겨 주세요.
저장소 전체 CONTRIBUTING 가이드는 Issue 분류, Pull Request 기준, 라이선스, 커뮤니티 링크를 설명합니다. 이 섹션은 Minara 고유의 확장 지점을 다룹니다.
변경 위치 선택하기
| 변경하려는 대상 | 먼저 볼 문서 |
|---|---|
| 문서 또는 번역 | 네 언어 파일을 함께 수정하고 아래 검사 실행 |
| 기존 도구를 활용하는 도메인 지식이나 반복 가능한 흐름 | 스킬 추가 |
| 결정론적 처리, 인증 API, 새로운 실행 기능 | 도구 추가 |
| Institution Mode 분석 틀이나 Deep Research 절차 | 분석 Playbook 추가 |
| 재사용할 수 있고 검증 가능한 투자 규칙 | 방법론 추가 |
| Runtime, Web UI, 데스크톱, 공유 패키지 | 시스템 설계와 가장 가까운 패키지 가이드 |
기존 도구로 기능을 구현할 수 있다면 스킬을 우선합니다. 인증, 결정론적 데이터 처리, 바이너리나 스트리밍 처리, 실행 경계가 필요할 때 도구를 추가합니다. 앱 전용 동작은 해당 앱에 두고 여러 앱이 공유하는 계약은 알맞은 공유 패키지에 둡니다.
개발 환경 구성하기
Node.js 24 이상과 Corepack으로 관리하는 pnpm 9.15.0이 필요합니다.
git clone https://github.com/Minara-AI/minara-agent.git
cd minara-agent
corepack enable
pnpm install
pnpm build:packages변경할 화면을 실행합니다.
pnpm dev:agent
pnpm dev:web-ui
pnpm dev:docs편집하기 전에 루트 CLAUDE.md, 가장 가까운 앱 또는 패키지의 CLAUDE.md, 관련된 모든 .claude/rules/*.md를 읽으세요. 이 파일들은 사람과 자동화 개발 도구가 함께 따르는 엔지니어링 계약입니다.
변경 검증하기
가장 좁은 범위의 테스트를 먼저 실행한 다음, 변경 영역에 맞는 넓은 검사를 실행합니다.
# Agent
pnpm --filter @minara/agent typecheck
pnpm --filter @minara/agent test:unit
# Web UI
pnpm --filter @minara/web-ui typecheck
pnpm --filter @minara/web-ui build
# 문서
pnpm --filter @minara/docs check:i18n
pnpm --filter @minara/docs lint:translations
pnpm --filter @minara/docs build공개 문서는 영어, 중국어, 일본어, 한국어로 함께 배포됩니다. 직접 작성한 MDX를 변경하면 .mdx, .cn.mdx, .ja.mdx, .ko.mdx 파일을 동시에 수정하세요. 내부 링크에는 로케일을 넣지 않고 /docs/contributing/conventions처럼 작성합니다.
검토하기 쉬운 Pull Request 만들기
한 Pull Request에서는 하나의 논리적 문제만 다룹니다. 문제, 변경 이유, 사용자 영향, 검증 명령이나 스크린샷을 설명하세요. 공개 API, 아키텍처, 여러 하위 시스템에 걸친 변경은 먼저 Issue에서 범위를 논의합니다.
비밀 정보, 계정 데이터, 사용자 거래 데이터, 호환되지 않는 라이선스의 외부 자료를 포함하지 마세요. 악용 가능한 취약점은 GitHub Private Vulnerability Reporting으로 신고하세요.
이어서 프로젝트 공통 규약을 확인하세요.