코드 포맷팅을 위한 필수 온보딩 교육이 있나요?

기여 기능
1

안녕하세요, 저는 https://discourse.bokeh.org를 운영하고 있으며, https://discuss.python.org에도 자주 방문합니다. 두 곳 모두에서 새로운 사용자가 첫 게시물에 코드를 올바르게 포맷하지 않는 문제가 매우 심각합니다. 특히 Python 메인 포럼에서는 하루에 여러 건의 게시물에서 사용자가 수정을 요청받아야 하는 상황이 발생하며, 이는 많은 사람들의 시간을 지속적으로 소모시키는 큰 부담입니다. [1]

새로운 사용자가 첫 게시물을 작성하기 전에 필수 온보딩 플로우를 도입하는 것이 가능할까요? 저는 사용자가 코드 포맷팅 방법을 배우고, 그 후 2~3줄의 포맷된 코드를 직접 재현하는 과제를 수행하도록 하는 플로우를 구체적으로 구상하고 있습니다. 이 과정을 성공적으로 완료해야만 게시물을 작성할 수 있도록 해야 합니다.

  1. 이는 Python의 경우 특히 악성적인 문제입니다. 왜냐하면 Python에서는 들여쓰기(indentation)가 의미론적으로 중요하기 때문입니다. ↩︎

2개의 좋아요
What about an "advanced" or "guided" submission process for new topics in certain categories
2

https://meta.discourse.org/t/unformatted-code-detector/112773를 보셨나요? 다른 몇몇 커뮤니티에서는 동일한 문제를 해결하는 데 도움이 되었습니다.

3개의 좋아요
3

네, 솔직히 말하면 성공은 제한적이었다고 봅니다. 적어도 https://discourse.bokeh.org에서는요. 하지만 제가 아는 한, Python 포럼에도 설치되어 있다고 합니다 (저는那里的 관리자ではありません).

2개의 좋아요
4

그렇지 않은 것 같은데, Unformatted Code Detector - #4 by jeanas - Discourse Feedback - Discussions on Python.org 를 참고해 보라. 나는 경고 메시지를 받지 않았다.

강제 온보딩이 도움이 될 수 있는 한 가지는 코드 화면 캡처가 포함된 게시글이다. 기존 “Unformatted code detector” 플러그인처럼, OCR을 사용하여 이러한 게시글에 경고를 표시할 수 있을 것이다.

나는 Bokeh를 사용하지 않으므로, 해당 플러그인이 잘 작동하는지 판단할 수 없다.

1개의 좋아요
5

사실, discuss.python.org에서는 포맷되지 않은 코드 감지 플러그인이 활성화되어 있습니다. 해당 포럼의 Users 카테고리를 살펴보니(최근 이 카테고리를 꾸준히 확인하진 않았지만), 솔직히 말하면 예전보다 훨씬 좋아진 모습이지만, 여전히 포맷되지 않은 코드가 포함된 게시글이 몇 개 있습니다.

6

참고로, 오늘 플러그인이 감지하지 못한 큰 코드 블록(임계값을 충분히 넘을 만한 크기)의 예시를 하나 소개합니다:

이 글을 계기로 온보딩/코드 포맷팅 주제에 대한 별도 논의가 벌어졌는데, 원글 작성자(OP)는 이 점에 대해 다소 불쾌해하는 반응을 보였습니다.

플러그인이 고장 난 건지, 업데이트가 필요한 건지 모르겠습니다. 어쨌든, 게시물을 올리기 전에 반드시 수행해야 하는 “이 코드를 포맷하세요” 과제를 ‘자동 감지’ 기능의 가치 있는 보완책으로 여전히 생각합니다.

1개의 좋아요
7

방금 기본 매개변수를 가진 테마 컴포넌트와 포맷되지 않은 예제의 코드를 확인해 봤는데, 잘 작동하는 것 같습니다.

image
image1920×1080 195 KB

8

결연히 말하지만, 링크된 게시물에 포함된 50줄 이상의 포맷팅되지 않은 코드를 막지는 못했습니다. 지금은 오히려 더 큰 논쟁으로 번져버렸네요. :slight_smile:

9

조금 더 강압적으로 해야 할까요? :unamused_face:
쉬운 첫 단계로는 버튼 텍스트를 살짝 조정하는 것일 수 있어요. 예를 들어 제출 버튼을 주의 !!! 정도로 바꾸는 거요…