我目前正在研究基于GitHub的R包，我想添加包含编码样式准则的markdown文本。问题是我找不到放置该信息的最佳位置。根据{{3}}，我不能只添加STYLE.md文件而不会使软件包无法通过基本的构建检查。他们说：
R包的源包含一个子目录，该子目录包含一个 文件Description和NAMESPACE，以及子目录R，数据，演示， exec，inst，man，po，src，测试，工具和小插曲（其中一些 可以丢失，但不能为空）。包装 子目录可能还包含文件INDEX，配置，清理， 许可，许可和新闻。其他文件，例如INSTALL（用于 非标准安装说明），README / README.md或 R将忽略ChangeLog，但对最终用户可能有用。
因此，我当前的解决方案是将样式指南集成到README.md文件中，但我不喜欢将其放在那儿，因为该指南是为软件包提供者而不是用户编写的；它对访问软件包主页的每个人都不可见（这是对用README.md编写并推送到GitHub的任何东西都会发生的情况）。
我想做的另一件事是为此创建一个小插图； rockchalk软件包Writing R Extensions的开发人员。但是，我的指南要短得多，我认为它与小插图的聚光灯和易于打印的格式不太匹配。
我还能/应该在哪里放样式指南？