병합 요청을 개선하는 방법 🤯

DRAFT 병합 요청 만들기

초안 병합 요청을 생성하면 팀에서 코드 검토를 가능한 한 빨리 수행하므로 더 나은 코딩을 달성하는 데 도움이 될 수 있습니다. 또한 그들은 당신이 놓쳤을 수도 있는 몇 가지 점에 당신의 주의를 끌어올릴 수 있을 것입니다.

명확한 설명 작성

이렇게 하면 팀원이 검토 중인 내용을 이해하는 데 도움이 됩니다.
모든 병합 요청은 간단하게 들릴 수 있는 설명을 받을 수 있지만 다루어야 하는 모든 사항을 확인하는 데 많은 도움이 될 수 있으며 팀이 코드가 무엇인지 이해하는 데 도움이 됩니다.

작은 기능

긴 함수는 디버깅 및 유지 관리가 어렵습니다. 그것을 테스트하고 그 맥락을 이해하는 것은 정말 어렵습니다.

function testing() {
    // ... really long function
}

작은 함수는 테스트 케이스를 작성할 때 케이스를 쉽게 처리하는 데 도움이 되며 특정 메서드/함수의 컨텍스트가 무엇인지 쉽게 이해하는 데 도움이 됩니다.

function testing() {
    // smallFunction_1();
    // smallFunction_2();
    // smallFunction_3();
}

더 설명적인 변수 이름

if 조건이 무엇인지 이해할 수 있습니까?

  if (
            PUBLIC_FILE.test(nextUrl.pathname) ||
            nextUrl.pathname.startsWith("/_next") ||
            nextUrl.pathname.includes("/api") ||
            nextUrl.pathname.includes("/log")
        ) {
            return undefined;
        }

소규모 병합 요청

때때로 우리는 코딩에 너무 흥분해서 엄청난 괴물 요청 👹을 생성합니다.
개발된 코드가 개발된 각 부분에 정말 빡빡할 수 있기 때문에 테스트, 코드 검토 수행 및 개선 사항 논의에 많은 노력이 필요하기 때문에 이것은 좋은 방법이 아닙니다. 작은 병합 요청은 이를 원활하게 처리하는 데 도움이 됩니다.

테스트 작성

테스트는 무언가가 예상대로 작동하고 있음을 증명하는 자연스러운 방법이며 논리적인 관점에서 코드를 잘 테스트하면 코드의 기능을 완전히 이해할 수 있습니다.

댓글 추가

코드에 주석을 추가하는 것은 핵심 기능과 코드의 응답을 설명하는 정말 강력한 방법입니다. 어떤 사람들은 코드에 주석이 필요한 경우 명확하지 않기 때문에 주석을 피해야 한다고 주장할 것입니다. 그러나 이것은 필요한 진실이 아닙니다. 때때로 우리는 당신과 당신의 팀이 XYZ 방법을 사용하여 무언가를 구현하기로 결정한 이유를 이해하는 데 도움이 될 정도로 많은 사례와 논리를 다루고 있습니다.

보시다시피, 이들은 간단한 제안이지만 코딩 검토를 통해 귀하와 귀하의 팀원을 도울 수 있는 매우 강력한 제안입니다.

👇 댓글 섹션에서 이 주제에 대해 어떻게 생각하는지 알려주세요.
👉 그것에 대해 더 알고 싶다면 저를 팔로우하세요.
✅ 이것은 내가 모든 유형의 주제를 쓰는 내 medium입니다.
👋 제 생각을 공유하는 곳입니다.