Типичные улучшения

Для поиска по тегу начните название тега с символа '@'.

Улучшения, показаны 33 из 33.

Используйте специальный синтаксис GitHub для ссылок на коммиты

GitHub поддерживает особый синтаксис для ссылок на коммиты. Он надежнее, удобнее и является общепринятым. Используйте …

Проверьте репозиторий(репозитории) на GitHub

Публикация кода на GitHub прошла с ошибками. Убедитесь сами - зайдите на сайт GitHub и …

Воспользуйтесь Git-ом

Начну с терминов: Git и GitHub — это разные вещи. GitHub — это место для …

Подключитесь к git-репозиторию по ssh

При каждом деплое GitHub будет запрашивать ваши логин и пароль. Это жутко неудобно. Настройте remote …

Сделайте коммиты понятнее

Название коммита важно. Это единственное место, где написано "зачем" были внесены изменения в этом коммите.

Разбейте коммит на несколько атомарных

Если объединять много правок в один коммит, то вся история изменений будет складываться из названий …

Уточните название файла

Названия файлов важны. Хорошее название подсказывает программисту, что лежит в файле и куда писать новый …

Почините битую разметку Markdown

В Markdown разметке легко ошибиться — поставьте один лишний символ \` и вы сломаете форматирование …

Выделите вставки кода в документации

Названия переменных, код и консольные команды внутри документации принято оформлять особым образом — как вставки …

Включите подсветку синтаксиса в блоках кода Markdown

Подсветка синтаксиса заметно облегчает чтение кода. Сразу становится видно где вызвана функция, где начинается цикл …

Исправьте битую ссылку

Если в ссылке нет ошибок, то она будет вести на нужную страницу или откроется заданная …

Добавьте в репозиторий .gitignore

Этот файл защитит ваш репозиторий от разного мусора. Также к “мусору” относятся папки `.idea`, `__pycache__`, …

Соблюдайте запрет на табы

В сообществе программистов Python запрещено использовать символы табуляции в качестве отступа перед блоком кода. Стандарт …

Удалите отладочные print

Эти вызовы `print` уже выполнили свою задачу, помогли отладить код. Теперь от них больше вреда …

Сделайте ссылки в документации кликабельными

Если ссылка в документе есть, но кликнуть по ней нельзя, то придется выделить и скопировать …

Добавьте файлы миграций БД

Если обновление в коде требует изменений структуры БД, а файлов с миграциями в репозитории не …

Замените поля CharField / TextField

В базе данных `CharField` и `TextField` представлены по-разному. `CharField` — это поле фиксированного размера, в …

Разбейте документацию на разделы

Когда в документации один текст, тратится много времени на прочтение, чтобы узнать, например, как установить …

Удалите media/ из репозитория

Если медиа-файлы лежат в репозитории, то они обязательно попадут на сервер вместе с очередным обновлением …

Добавьте в README описание проекта

Никто не будет использовать ваш код, если вы не расскажете, что он делает. Поэтому в …

Разбейте одно предложение на несколько

Чем больше информации в документе, тем сложнее его понять. Бывает, что в документе всё на …

Спрячьте чувствительные данные

Не стоит хранить в коде токены, секретные ключи и прочие пароли. Код рано или поздно …

Очистите токен

Программа не может авторизоваться на Девмане по токену. Вместо токена она требует в настройках строку …

Вынесите вставки кода в отдельные блоки

В Markdown есть два формата для вставок кода. Первый — это inlines. Его применяют для …

Замените HTML теги на разметку Markdown

Разметку Markdown любят за её выразительность и простоту. В сравнении с HTML здесь не надо …

Перезалейте репозиторий

Когда открываешь репозиторий, ожидается сразу увидеть проект с документацией. Если несколько проектов лежат в одном …

Настройте .gitignore

Улучшение для 3 урока Django

Сообщайте о деплое только после окончания деплоя

Вы уже сообщили в Rollbar о успешном деплое, но ведь его ещё не состоялось! А …

Заставьте деплойный скрипт замечать ошибки

Если сломается любая из management-команд, то, по идее, деплой должен быть прерван, а по факту …

Укажите ссылку на нужное решение

На проверку пришла работа со ссылкой на решение другого урока/задания

Переместите картинки из репозитория в GitHub Issues

Очень часто для наглядности хочется показать в README изображения (скриншоты или gif) и возникает вопрос: …

deprecated
Переместите картинки из репозитория в GitHub Issues

Очень часто для наглядности хочется показать в README изображения (скриншоты или gif) и возникает вопрос: …

deprecated