업로드하기

패치 업로드하기

사용설명서 수정 입문자라면, 사용설명서 관리자가 검토할 수 있도록 패치 형태로 보내주어야 해요. 우리가 믿음직한 사용설명서를 유지하기 위해 꼭 필요한 과정이에요. 처음 하는 사람이 혹시라도 중요한 데이터를 건드리면 안 되니까요.

패치를 업로드하려면 이 순서대로 따라해주세요.

  1. 일단 수정을 다 마쳤겠죠?

  2. 이 명령어로 패치 파일을 만드세요.

    svn diff > filename.diff

    원래 서버로부터 동기화된 폴더에서 어떤 내용이 추가되고, 없어지고, 수정되었는지를 정리해둔 간단한 텍스트 파일이 만들어질 거예요.

    파일을 새로 만들었거나 삭제했다면, svn add /path/to/file 이나 svn rm /path/to/file 명령어를 diff를 만들기 전에 실행해주세요. 변경된 파일들의 목록을 보려면 svn status 명령어를 실행하면 돼요.

  3. 여기에 그 diff파일을 업로드해주세요. 아직 계정이 없다면, 여기서 쉽게 만들 수 있어요.

  4. diff를 보내주고 나면, 제목과 설명을 쓰면서 새 개정본을 만들지(create a new revision) 질문받을 거예요.

  5. Please check if the Documentation project is assigned in the tag’s field in order to notify the team of your patch. You can also contact the team over the mailing list or Blender Chat.

  6. They will review your patch and let you know about any changes you could make. If there is no issue, your patch will be accepted and then committed by the team of your patch.

참고

만약 패치에 이미지 변경사항이 포함되어 있다면, 개정본을 만들 때 이미지도 같이 첨부해 주세요.

올바르게 잘 만들어진 패치는 아주 빠르게 반영돼요. 기여자님이 몇 번 하고서 이 일에 익숙해지고 피드백이 없어도 되는 수준이 되면, 검토 단계를 빼고 기여자님에게 특별히 사용설명서를 직접 수정할 권한을 줄 거예요.

직접 업로드하기

Once you are provided with the direct access to edit the manual, you can start committing directly instead of creating a patch file. Doing this will submit the change directly to our central repository.

이 명령어를 실행하면 돼요.

svn commit -m "This is what I did"

-m "message" 를 명령어에 안 썼다면, 텍스트 편집기에서 메시지를 쓰라고 할 거예요.

업로드하기 전에 ``svn update``를 꼭 실행하세요.

commit 명령어를 실행했다면, developer.blender.org 계정 이름과 비밀번호를 입력하라고 할 거예요.

수정된 파일은 중앙 저장소에 곧바로 업로드되어 다른 사람들과 함께 공동으로 작업할 수 있어요. 업로드한 내역은 Diffusion 저장소에 남게 돼요. 조금 있으면 변경사항이 온라인 사용설명서에 반영될 거예요.

Writing a Good Commit Message

When making changes to the manual that directly relate to a specific commit (change) in Blender, it is helpful to make the title of the commit the same as the commit made to Blender. It is requested that you include the commit hash of the commit made to the Blender source code.

For example, the commit rBM8473 includes a descriptive indicative of the changes made along with the hash rBa71d2b260170. The hash can be extracted from the URL provided in the Documentation task for a specific upcoming release.

Other more general changes do not have to follow the above policy however, it is still important to make the description clear about what changes you made and why. It can be helpful to prefix the commit title with a prefix word such as Cleanup: or Fix: when you are making general cleanups or fixes respectively.

Writing good commit messages helps administrators keep track of changes made and ensures all new features are properly documented.