> For the complete documentation index, see [llms.txt](https://newmishka.gitbook.io/newmishka-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://newmishka.gitbook.io/newmishka-docs/razrabotka/kak-vnesti-vklad.md).

# Как внести вклад

## Для людей и AI-агентов

Процесс разработки `arm_info` не зависит от конкретной IDE, модели или AI-агента. GitHub является источником актуального состояния проекта, а обязательные проверки и правила интеграции одинаковы для всех участников.

AI-агентам рекомендуется сначала прочитать:

* `AGENTS.md` — расширенный технический и процессный контракт проекта;
* `.github/CONTRIBUTING.md` — универсальные правила внесения изменений.

Если среда не поддерживает Superpowers, Context7, GitBook-коннектор или другой упомянутый инструмент, это не блокирует работу: используйте эквивалентную методологию и официальную upstream-документацию.

Для популярных агентов в репозитории также есть тонкие адаптеры:

* `CLAUDE.md` — для Claude Code;
* `.github/copilot-instructions.md` — для GitHub Copilot.

Эти файлы не заменяют общий контракт и ссылаются на единые правила проекта.

## Перед изменениями

1. Проверьте актуальный `main`, текущую ветку, релевантные issues/PR и CI.
2. Создайте отдельную ветку и не отправляйте изменения напрямую в `main`.
3. Не ломайте single-file запуск `arm_info.sh`.
4. Сохраняйте read-only поведение диагностики по умолчанию.
5. Для новых CLI-параметров обновляйте help, README и тесты.
6. Для новых рекомендаций добавляйте понятное описание эффекта команды.
7. Если меняется публичное поведение, обновляйте соответствующую документацию вместе с кодом.

Рекомендуемый общий процесс:

```
понять задачу
    ↓
воспроизвести / проверить текущее поведение
    ↓
внести минимальное изменение
    ↓
добавить или обновить тесты
    ↓
проверить итоговый diff
    ↓
Pull Request
    ↓
CI
    ↓
merge только после решения владельца проекта
```

## Локальные проверки

```bash
make version
make check
make test
```

`make version` сверяет версию из `VERSION` с `arm_info.sh` и RPM spec.

Для изменений только документации всё равно проверьте итоговый diff и убедитесь, что production-файлы не изменены.

## Документация

При изменении поведения скрипта обновляйте соответствующую страницу GitBook и документацию в репозитории в том же цикле работы.

Если у используемого агента нет доступа к GitBook, он должен обновить документацию в репозитории и явно указать, какие изменения ещё требуется перенести в GitBook. Нельзя утверждать, что GitBook синхронизирован, если это не было проверено.

## Pull Request

В PR желательно указать:

* что изменено;
* зачем;
* какие сценарии проверены;
* возможные риски/регрессии;
* какие документы обновлены.

Merge PR, release/tag и публикация GitBook не выполняются агентом без явного подтверждения владельца проекта.

Подробные правила проекта:

<https://github.com/NewMishka/arm\\_info/blob/main/.github/CONTRIBUTING.md>

Расширенный контракт для AI-агентов:

<https://github.com/NewMishka/arm\\_info/blob/main/AGENTS.md>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://newmishka.gitbook.io/newmishka-docs/razrabotka/kak-vnesti-vklad.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
