У меня маленький проект для себя. Зачем ему ридми?
Илья
Цель ридми – рассказать, что делает модуль и как им пользоваться. Если ридми нет, эти вопросы остаются без ответа.
Проект для себя может превратиться в проект не только для себя. Без ридми новичку в проекте придётся тяжело.
А может получиться, что ты вернёшься к проекту через полгода. Тогда тяжело будет уже тебе, автору. Особенно тяжело будет, если таких проектов за полгода с десяток и ни в одном нет ридми. Только найти нужный – уже проблема. Названия-то забылись все.
Если проект лежит в открытом доступе, его кто-то увидит. Найдёт в гугле, перейдёт по тегам на Гитхабе, мало ли как. Ему надо сказать: «эй, чувак, тут ничего интересного, проходи». Или наоборот: «тут реализован метод Мак Кормака, бери, если надо». Иначе ему придётся лезть в код, разбираться, тратить время. Это неуважение.
Ну а если проект не только для себя, то без ридми вообще нельзя.
Попробуйте бесплатные уроки по Python
Получите крутое код-ревью от практикующих программистов с разбором ошибок и рекомендациями, на что обратить внимание — бесплатно.
Переходите на страницу учебных модулей «Девмана» и выбирайте тему.