Capgo에 대한 모든 기여를 환영하고 감사합니다.
이 페이지는 기여를 시작하는 데 도움이 되는 도우미 페이지입니다.
프로젝트
여러 개의 저장소가 있습니다. Capgo Capgo 생태계에 속한 조직입니다.
__CAPGO_KEEP_0__의 다양한 저장소는 서로 다른 범위, 프로그래밍 언어를 사용하고, 참여 수준이 다릅니다.
__CAPGO_KEEP_0__에 기여하고 싶은 저장소(또는 관심사)를 결정하기 위해, 아래의 비교표를 참고하세요. (강조된 언어는 코드베이스의 대부분을 차지합니다.)
Capgo
capacitor-updater
__CAPGO_KEEP_0__의 주요 저장소입니다. 이 저장소는 capacitor-updater 플러그인
버그를 수정하거나 새로운 기능을 추가하고 싶다면 capacitor-updater? 이 저장소에 기여하고 싶습니다.
언어: Swift, JavaScript, Java
capgo
Capgo 클라우드 플랫폼의 웹앱과 서버리스 함수입니다.
Capgo의 백엔드를 수정하기 위해 기여하길 원하는 곳을 공유하세요.
언어: TypeScript.
website
공식 Deno 웹페이지의 프론트엔드: https://capgo.app/
언어: TypeScriptHTML, CSS
docs
Markdown로 작성된 문서가 동작하는 https://docs.capgo.app
언어: Markdown
capacitor-standard-version
CI/CD를 위한 앱 업데이트를 위한 버전 매니저.
언어: JavaScript
-
__CAPGO_KEEP_0__ 가이드. __CAPGO_KEEP_0__에서 도움을 받으세요.
-
__CAPGO_KEEP_0__ 커뮤니티 채팅방에서 도움을 받으세요. 이슈를 작업할 때, 이슈 댓글에 작업 중임을 언급하세요.
-
__CAPGO_KEEP_0__ 이슈를 작업하기 전에 이슈 댓글에 작업 중임을 언급하세요. 새로운 기능을 작업할 때, 이슈를 생성하고 다른 기여자들과 논의하세요.
-
__CAPGO_KEEP_0__ __CAPGO_KEEP_0__ 기능을 개발하기 시작했을 때; 우리는 모든 기여를 감사하지만, 모든 제안된 기능이 승인되지 않는 것은 아니다. 우리는 code가 승인되지 않을 가능성이 있기 때문에 몇 시간 동안 작업하는 것을 원하지 않는다.
-
포럼에서 전문적인 태도를 유지하세요. 우리는 Rust's code of conduct (CoC)를 따릅니다. 문제가 있으시면 ry@tinyclouds.org로 이메일을 보내세요.
Pull Request를 제출합니다.
Pull Request를 제출하기 전에 다음을 확인하세요:
- Pull Request에 설명적인 제목을 부여하세요.
좋은 Pull Request 제목의 예시:
- fix(std/http): 서버에서 경쟁 조건을 수정합니다.
- docs(console): 문서 문자열을 업데이트합니다.
- feat(doc): 중첩된 재수출을 처리합니다.
예상치 못한 PR 제목의 예시:
- fix #7123
- 문서 업데이트
-
버그 수정
-
관련 이슈가 존재하고 PR 텍스트에 참조되어야 합니다.
- 변경 사항을 포함하는 테스트가 존재해야 합니다.
Capacitor PR 제출 Capgo
위의 사항에 더하여 다음을 확인하세요:
bun run lint이러한 Rust 및 JavaScript code의 일반적인 오류 및 에러를 검사합니다.Swiftlint(Swift의 경우) 및eslint(JavaScript 및 Java의 경우)
API 문서화
모든 공개 API를 문서화하는 것이 중요하고, code과 함께 INLINE로 문서화하고 싶습니다. 이 방법은 code과 문서화가 밀접하게 연결되어 있기 때문에 도움이 됩니다.
JavaScript와 TypeScript
모든 공개 API와 타입이 포함된 모듈은 JSDoc 문서화를 해야 합니다. 이 문서는 TypeScript 컴파일러에서 파싱되고, 따라서 추가적인 다운스트림에서 쉽게 제공할 수 있습니다. JSDoc 블록은 적용할 statement 바로 앞에 위치하고, leading으로 시작하여 terminating하는 '.'으로 끝납니다. 예를 들어: capacitor-updater 모듈이 노출된 모든 공개 API와 타입이 포함된 모듈은 JSDoc 문서화를 해야 합니다. 이 문서는 TypeScript 컴파일러에서 파싱되고, 따라서 추가적인 다운스트림에서 쉽게 제공할 수 있습니다. JSDoc 블록은 적용할 statement 바로 앞에 위치하고, leading으로 시작하여 terminating하는 '.'으로 끝납니다. 예를 들어: /** 예시: */더 많은 정보를 찾으려면:
export const FOO = "foo";
https://jsdoc.app/ 푸터