Стайлгайд

Соглашение об оформлении кода

Прежде всего, разработку каждого модуля нужно вести в отдельной ветке (название должно быть вида xtensa-esp8266-module, где module - название модуля).

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

Мержить в xtensa-esp8266 можно только после проверки работоспособности прошивки на контроллере и с согласия участников проекта.

Все названия папок и файлов, а также комментарии в коде и коммиты должны быть на английском языке.

Для названий используем Си-подобный синтаксис: все с маленькой буквы, для разделения используем подчеркивание.

Остальную часть можно прочитать здесь.

Правила оформления Wiki

Основные принципы:

• Не создавайте лишние страницы
• Делите страницу на связные разделы
• Не пишите "сочинения", текст должен легко читаться
• Ссылки и перечисления приветствуются
• Ставьте точки

Поля

Названия переменных, пути к файлам, команды и другие относящиеся к коду или консоли вставки должны быть выделены полями (например, Some code).

Если вы указываете путь к файлу, он должен начинаться в корне репозитория, например ./templates/xtensa/esp8266/.

Команды для консоли должны отделяться полем на всю строку (каждая команда начинается с $), например:

$ Your command

Для создания поля, используйте обратные кавычки. Для списка команд поставьте 3 кавычки до и после.

Ссылки

Для создания ссылки используйте структуру [That you see](https://address.com), напрямую указывать ссылки запрещается!

Например, OS Embox.

Существующие ветки, файлы и пути к ним - должны обязательно сопровождаться ссылками и оформляться согласно предыдущим пунктам, например make_image.sh.