✏️ README без рутины

Когда README пустой, а функции без комментариев, скорость онбординга падает, качество ревью страдает, а знание о системе «залипает» в головах нескольких разработчиков.

Решение — стандартизированный промпт, который за один проход обновляет всю информацию о проекте.

Промпт:

Сгенерируй README.md и обнови/добавь docstrings для проекта на {язык}. Прежде чем выполнять изменения, придерживайся следующих инструкций и форматов. Если репозиторий не приложен — попроси его либо дай инструкции, как передать код.

- Не вноси изменения в поведение кода — только README и docstrings/комментарии.
- Формат вывода: верни
1) Содержимое README.md (в виде одного блока текста),
2) Список изменённых файлов с полным обновлённым содержимым каждого файла или unified diff (укажи предпочитаемый формат),
3) Краткое резюме изменений (1–3 предложения) и предложенное сообщение коммита.

Требования к README.md (сгенерируй в следующем порядке)
1. Название проекта и одна-две строки краткого описания.
2. Секция «Требования» — перечисли зависимости/версии. Если проект использует файл зависимостей, упомяни соответствующий файл.
3. Секция «Установка» — шаги установки и настройки (локальная установка, виртуальное окружение).
4. Секция «Примеры использования» — 2–3 минимальных примера с командами/фрагментами кода и ожидаемым выводом.
5. Секция «Как это работает» — краткая архитектура, ключевые модули/пакеты и их роли (3–6 пунктов).
6. Секция «Ограничения» — известные ограничения и граничные случаи.
7. Секция «FAQ» — 6–8 часто задаваемых вопросов с краткими ответами.
8. Дополнительно: «Тесты», «Контрибьюция», «Лицензия», «Контакты/Автор» — включи, если уместно.

Требования к docstrings
- Модуль: короткое описание, при необходимости пример использования.
- Классы: краткое назначение, описание атрибутов и пример использования в классовом контексте.
- Методы/функции: однострочное резюме; подробное описание;
- Для большого проекта: если функция одна-две строки, используй краткий формат; для публичных API — подробный.
- Ограничение длины строк: 88 символов.

Процесс,
1. Если у тебя есть доступ к файлам: пройди по всем *.{расширения для языка} файлам в репозитории и обнови/добавь docstrings согласно выбранному стилю.
2. Для каждого изменённого файла: верни либо полный новый файл, либо unified diff. Не изменяй кодовую логику.
3. Если репозиторий не приложен: напомни мне о том, как передать файлы/ссылку и предложи шаблон команды для загрузки.

Если нужна дополнительная информация (например, предпочитаемый стиль docstring или пример теста), спроси её отдельно и не приступай к изменениям до получения ответа.

🐸Библиотека Go-разработчика

#буст

💡 Новые дефолты GOMAXPROCS

В Go 1.25 значение GOMAXPROCS автоматически берётся из CPU-лимита контейнера и периодически обновляется при его изменении. Это снижает троттлинг и хвостовую латентность без ручной настройки.

Подробнее об этом рассказывают в блоге разработчиков Go.

🐸Библиотека Go-разработчика

#свежак

📚 Документация для Go прямо из командной строки

Godoc — это официальный инструмент для генерации и отображения документации по Go-коду.

В отличие от обычной документации, которую приходится искать в интернете, Godoc позволяет локально или онлайн работать с документацией без лишних усилий.

Установка:

go install golang.org/x/tools/cmd/godoc@latest

Запуск локального сервера c документацией:

godoc -http=:6060

Просмотр документации для пакетов:

godoc fmt

Чтобы узнать подробности о конкретной функции или типе:

godoc fmt Printf

🐸Библиотека Go-разработчика

#буст

🎸 IT, костер, гитара: как за 5 шагов организовать драйвовый корпоратив

Чтобы ваш корпоратив приобрёл статус настоящего события года, необходимо учитывать ряд важных аспектов, которые гарантируют создание уникальной и яркой атмосферы.

В статье все ключевые моменты, которые помогут вам грамотно организовать и провести мероприятие на высшем уровне.

➡️ Читать статью

🐸Библиотека Go-разработчика

📰 Дайджест недели

Собрали для вас в одном месте всё, что произошло за эту неделю.

— Go поднялся на одну строчку в рейтинге TIOBE

— WaitGroups в Go и упрощённый API

С релизом Go 1.25 появился метод wg.Go(func()), который автоматически инкрементирует счётчик, запускает функцию в горутину и декрементирует счётчик при её завершении — всё в одном месте.

— Свежий выпуск Cup o' Go

— Новые дефолты GOMAXPROCS

🐸Библиотека Go-разработчика

#свежак

🏃‍♀️ Новый поток курса — собери своих AI-агентов

7 октября стартует второй поток курса «AI-агенты для DS-специалистов».
За 5 недель вы научитесь собирать агентов, которые уже сейчас будут помогать бизнесу.

В кружке выше Максим Шаланкин, наш преподаватель, рассказывает подробнее — включай, чтобы не пропустить.

👉 Записаться на курс

🦆 Топ-вакансий для Go-разработчиков за неделю

Golang-разработчик — Офис (Казань).

Golang разработчик (senior) — Гибрид (Москва).

Go Team Lead — до 450 000 ₽, Удалённо (Москва).

Junior Golang Developer — от 1700 $, Удалённо.

Руководитель группы разработки — от 585 000 ₽, Удалённо (Москва).

Go-разработчик — до 500 000 ₽, Удалённо (Москва).

Бустер — удалённо (не только Москва).

➡️ Еще больше топовых вакансий — в нашем канале Go jobs

💡 Как обработать статус-коды по API

Иногда хочется написать простое API на Go и быстро отдать JSON-ответ. Но апи это не только про данные, но и про разные статус-коды — 200, 400, 500. Давайте сделаем это максимально минималистично.

Простой сервер с обработкой статусов:

package main

import (
  "encoding/json"
  "net/http"
)

type Response struct {
  Status  int    `json:"status"`
  Message string `json:"message"`
}

func handler(w http.ResponseWriter, r *http.Request) {
  if r.Method != http.MethodGet {
    w.WriteHeader(http.StatusMethodNotAllowed)
    json.NewEncoder(w).Encode(Response{Status: 405, Message: "Метод не поддерживается"})
    return
  }

  w.WriteHeader(http.StatusOK)
  json.NewEncoder(w).Encode(Response{Status: 200, Message: "Все ок!"})
}

func main() {
  http.HandleFunc("/", handler)
  http.ListenAndServe(":8080", nil)
}

В итоге у нас минималистичный сервер, который отвечает корректным статусом и JSON, а не просто «Hello world» в лоб.

🐸Библиотека Go-разработчика

#буст