cryptoadvocate/cryptohackappCryptohack Badge 프로젝트의 모바일 엔지니어링 홈입니다.
GitLab을 쉽게 시작할 수 있도록 다음 권장 단계를 알려드립니다.
이미 전문가이신가요? 이 README.md를 편집하여 자신의 것으로 만드세요. 쉽게 만들고 싶으신가요? 아래 템플릿을 사용하세요!
cd existing_repo
git remote add origin https://gitlab.com/cryptoadvocate/cryptohackapp.git
git branch -M main
git push -uf origin main
GitLab에 내장된 지속적 통합을 사용하세요.
이 README를 자신의 것으로 만들 준비가 되셨나요? 이 파일을 편집하고 아래 편리한 템플릿을 사용하세요(또는 원하는 대로 자유롭게 구성하세요 - 이것은 단지 시작점일 뿐입니다!). 이 템플릿을 제공해 주신 makeareadme.com에 감사드립니다.
모든 프로젝트는 다르므로, 다음 섹션 중 어떤 것이 귀하의 프로젝트에 적용되는지 고려하세요. 템플릿에 사용된 섹션은 대부분의 오픈 소스 프로젝트에 대한 제안입니다. 또한 README가 너무 길고 상세할 수 있지만, 너무 짧은 것보다는 긴 것이 낫다는 점을 명심하세요. README가 너무 길다고 생각되면 정보를 잘라내지 말고 다른 형태의 문서를 활용하는 것을 고려하세요.
프로젝트에 스스로 설명이 가능한 이름을 선택하세요.
사람들에게 귀하의 프로젝트가 구체적으로 무엇을 할 수 있는지 알려주세요. 컨텍스트를 제공하고 방문자가 생소할 수 있는 참조 자료에 대한 링크를 추가하세요. 기능 목록이나 배경 하위 섹션을 여기에 추가할 수도 있습니다. 귀하의 프로젝트에 대한 대안이 있다면, 차별화 요소를 나열하기 좋은 곳입니다.
일부 README에서는 프로젝트의 모든 테스트 통과 여부와 같은 메타데이터를 전달하는 작은 이미지를 볼 수 있습니다. Shields를 사용하여 README에 추가할 수 있습니다. 많은 서비스에서 배지 추가를 위한 안내도 제공합니다.
만드는 것에 따라 스크린샷이나 비디오를 포함하는 것이 좋습니다(실제 비디오보다는 GIF를 자주 볼 수 있습니다). ttygif 같은 도구가 도움이 될 수 있지만, 더 정교한 방법으로는 Asciinema를 확인해 보세요.
특정 생태계 내에서는 Yarn, NuGet, 또는 Homebrew를 사용하는 등 일반적인 설치 방법이 있을 수 있습니다. 그러나 README를 읽는 사람이 초보자이며 더 많은 안내를 원할 수도 있다는 점을 고려하세요. 구체적인 단계를 나열하면 모호함을 없애고 사람들이 가능한 한 빨리 프로젝트를 사용할 수 있게 됩니다. 특정 프로그래밍 언어 버전이나 운영 체제와 같은 특정 컨텍스트에서만 실행되거나 수동으로 설치해야 하는 의존성이 있는 경우, 요구 사항 하위 섹션도 추가하세요.
예제를 많이 사용하고, 가능하다면 예상 출력을 보여주세요. 시연할 수 있는 가장 작은 사용 예제를 인라인으로 포함하고, README에 포함하기에는 너무 긴 고급 예제에 대한 링크를 제공하는 것이 좋습니다.
사람들이 도움을 받을 수 있는 곳을 알려주세요. 이슈 트래커, 채팅방, 이메일 주소 등 다양한 조합이 가능합니다.
향후 릴리스에 대한 아이디어가 있다면 README에 나열하는 것이 좋습니다.
기여를 받고 있는지, 그리고 기여를 수락하기 위한 요구 사항은 무엇인지 명시하세요.
프로젝트에 변경 사항을 적용하려는 사람들을 위해 시작하는 방법에 대한 문서가 있으면 도움이 됩니다. 실행해야 하는 스크립트나 설정해야 하는 환경 변수가 있을 수 있습니다. 이러한 단계를 명확하게 설명하세요. 이 지침은 미래의 자신에게도 유용할 수 있습니다.
코드를 린트하거나 테스트를 실행하는 명령어를 문서화할 수도 있습니다. 이러한 단계는 높은 코드 품질을 보장하고 변경 사항이 의도치 않게 무언가를 망가뜨릴 가능성을 줄이는 데 도움이 됩니다. 브라우저에서 테스트하기 위해 Selenium 서버를 시작하는 등 외부 설정이 필요한 경우 특히 테스트 실행 지침이 유용합니다.
프로젝트에 기여한 사람들에게 감사를 표하세요.
오픈 소스 프로젝트의 경우 라이선스 방식을 명시하세요.
프로젝트에 에너지나 시간이 부족하다면 README 상단에 개발이 느려졌거나 완전히 중단되었다는 메모를 추가하세요. 누군가가 프로젝트를 포크하거나 유지보수자 또는 소유자로 자원할 수도 있습니다. 유지보수자를 명시적으로 요청할 수도 있습니다.