CONTRIBUTING.md

Как участвовать

Правки принимаются. Ниже то, что стоит знать до того, как открывать PR.

Собрать и проверить

git clone https://github.com/AutoPasha/cli.git
cd cli
npm test

Нужен Node.js 20 или новее. Устанавливать нечего: зависимостей у пакета нет ни в работе, ни в разработке.

Что важно в этом репозитории

• Зависимостей не добавляем. Командная строка, которая тянет полсотни чужих пакетов, плохо ставится в CI и тяжело проверяется на доверие. Если без зависимости совсем никак, объясните в PR, почему её нельзя заменить двадцатью строками.
• Сеть в тестах не участвует. Клиент API получает свой fetch подставкой, поэтому тесты идут одинаково на ноутбуке и в CI. Тест, которому нужен живой сервер, мы не примем.
• Ошибка должна лечиться словами. Человек, который увидел сообщение, должен понять, что ему сделать: набрать autopasha login, завести ключ в кабинете, подождать. 401 unauthorized человеку не говорит ничего.
• Код возврата честный. 0 - сделано, 1 - нет. Ничего третьего.

Пул-реквест

• Одна правка - один PR, так его быстрее прочитать.
• На поведение нужен тест: node --test рядом, в test/.
• Заметное для пользователя пишется в CHANGELOG.md, в раздел «Не выпущено».
• Зелёный CI обязателен: тесты идут на Node 20, 22 и 24.

Нашли дыру в безопасности

Не открывайте issue, напишите на help@autopasha.ru. Подробности в SECURITY.md.