В настоящее время я работаю над пакетом R на основе GitHub и хочу добавить текст уценки, содержащий рекомендации по стилю кодирования.Проблема в том, что я не могу найти лучшее место для размещения этой информации.Согласно Writing R Extensions , я не могу просто добавить файл STYLE.md, если пакет не прошел проверку базовой сборки.Они говорят:
Источники пакета R состоят из подкаталога, содержащего файлы DESCRIPTION и NAMESPACE, и подкаталогов R, data, demo, exec, inst, man, po, src, tests,инструменты и виньетки (некоторые из которых могут отсутствовать, но которые не должны быть пустыми).Подкаталог пакета также может содержать файлы INDEX, configure, cleanup, LICENSE, LICENSE и NEWS.Другие файлы, такие как INSTALL (для нестандартных инструкций по установке), README / README.md или ChangeLog, будут игнорироваться R, но могут быть полезны для конечных пользователей.
Поэтому мое текущее решениеинтегрировать руководство по стилю в файл README.md, но мне не нравится, когда оно там есть, потому что это вспомогательное руководство, написанное для участников пакета, а не для пользователей;он не должен быть видимым для всех, кто посещает домашнюю страницу пакета (что происходит с чем-либо, написанным на README.md и отправленным на GitHub).
Еще одна вещь, о которой я подумал, - это создать виньетку для этого;разработчики пакета rockchalk сделали именно это .Тем не менее, мое руководство намного короче, я не думаю, что оно хорошо вписывается в центр внимания и удобный для печати формат виньеток.
Где еще можно / нужно разместить руководство по стилю?