Capgo에 대한 모든 기여를 환영하고 감사드립니다.
이 페이지는 기여를 시작하는 데 도움을 주는 안내서 역할을 합니다.
프로젝트
Capgo 조직에는 Capgo의 일부인 수많은 저장소들이 있습니다.
저장소마다 다른 범위를 가지고 있으며, 서로 다른 프로그래밍 언어를 사용하고 기여도 측면에서 다양한 수준을 보입니다.
어느 저장소에서 기여를 시작하는 것이 가장 좋을지(그리고/또는 귀하의 관심사에 해당하는지) 결정하는 데 도움이 되도록, 다음과 같은 간단한 비교를 제공합니다(<strong> 굵은 글씨로 표시된 언어가 코드베이스의 대부분을 차지합니다 </strong>): Capgo
capacitor-updater
이는 capacitor-updater 플러그인을 제공하는 주요 저장소입니다.
capacitor-updater의 버그를 수정하거나 새로운 기능을 추가하고 싶으신가요? 이 저장소가 바로 여러분이 기여하고자 하는 곳입니다.
Languages: Swift, JavaScript, Java
capgo
Capgo 클라우드 플랫폼을 구성하는 웹 애플리케이션 및 서버리스 함수.
Capgo의 백엔드를 수정하는 데 기여하고 싶은 곳으로 이동하세요.
Languages: TypeScript.
website
Deno 공식 웹페이지를 위한 프론트엔드: https://capgo.app/
Languages: TypeScript, HTML, CSS
docs
Markdown으로 작성된 문서가 구동하는 https://doc.capgo.app
Languages: Markdown
capacitor-standard-version
CI/CD를 통해 앱을 업데이트하는 버전 관리자.
Languages: JavaScript
-
스타일 가이드를 읽으세요.
-
커뮤니티 채팅방에서 도움을 요청하세요.
-
문제를 작업할 때, 작업을 시작하기 전에 해당 이슈의 댓글에 언급해 주세요.
-
새로운 기능을 작업할 때는 먼저 이슈를 생성하고 다른 기여자들과 논의하세요. 그 후에 기능 개발을 시작하십시오. 우리는 모든 기여를 감사히 여기지만, 제안된 모든 기능이 수락되는 것은 아닙니다. 우리는 당신이 수락되지 않을 수 있는 코드에 시간을 많이 투자하는 것을 원하지 않습니다.
-
포럼에서 전문적으로 행동해 주세요. 우리는 Rust의 행동 강령(CoC)을 따릅니다. 문제가 있으신가요? ry@tinyclouds.org로 이메일을 보내주세요.
풀 리퀘스트 제출하기
PR을 어느 레포지토리에 제출하기 전에 다음 사항이 완료되었는지 확인해 주세요:
- PR에 설명적인 제목을 부여하세요.
좋은 PR 제목의 예시:
- fix(std/http): Fix race condition in server
- docs(console): Update docstrings
- feat(doc): Handle nested re-exports
잘못된 PR 제목의 예시:
- fix #7123
- update docs
-
fix bugs
-
Ensure there is a related issue and it is referenced in the PR text.
- Ensure there are tests that cover the changes.
Capgo에 PR을 제출하기
위의 내용에 추가하여 다음 사항을 확인하십시오:
npm run lint통과 - 이는Swiftlint(Swift용)와eslint(JavaScript 및 Java용)를 사용하여 Rust와 JavaScript 코드의 일반적인 실수와 오류를 확인합니다
API 문서화
모든 공개 API를 문서화하는 것이 중요하며 우리는 코드와 함께 인라인으로 이를 수행하고자 합니다. 이는 코드와 문서가 긴밀하게 연결되도록 보장하는 데 도움이 됩니다.
JavaScript 및 TypeScript
공개적으로 노출된 모든 API와 타입, capacitor-updater 모듈은 JSDoc 문서를 가져야 합니다. 이 문서는 파싱되어 TypeScript 컴파일러에서 사용할 수 있으며, 따라서 추가적인 downstream에 쉽게 제공할 수 있습니다. JSDoc 블록은 적용되는 문장 바로 앞에 위치하며 시작 부분에 /**를 사용하고 */로 종료됩니다. 예를 들어:
export const FOO = "foo";
더 자세한 내용은 다음에서 확인하세요: https://jsdoc.app/