微软让作者可在NuGet组件打包README文件

微软宣布组件作者现在可以将README.md文件,打包进NuGet组件中,README内容就能被完整呈现在NuGet.org上,官方提到,这项功能还在预览阶段,想要快速尝试这个功能,可以安装最新的.NET 6或是Visual Studio预览版本。

微软在前些时日,对NuGet社群进行调查,微软发现最大的问题,是大多数组件的文件无法从NuGet.org简单取用,有45%的调查受访者认为,需要的重要组件在NuGet.org上都存在,但是缺乏良好的文件说明,甚至于对NuGet生态系统感到不满意。

过去微软在NuGet.org上提供Markdown文件支持,但是这要求作者要在NuGet.org上,对每个新的组件版本,都粘贴README或是README连接,这个程序对作者来说太过麻烦,而现在微软改进README的处理体验,作者能以处理图标或是授权等其他嵌入式组件文件的方式,来处理README.md文件。

作者不用特地到NuGet.org,可以使用熟悉的NuGet组件工具添加说明文件,而作者一旦在项目文件中加入README.md路径,则最新的README文件便会每次都被打包进组件,也就是说作者现在只需要设置一次,之后就不再麻烦。README是不可变更,而且专属于特定版本,因此组件用户也可以查看其他旧版组件中README。

组件作者可以预览README文件,只要使用NuGet.org上传网页门户网站上传组件,就可以从网页下方元资料区块预览README文件,想要修正组件的README文件,作者必须推送组件更新版本。微软建议作者,可以花一些时间查看和预览README文件,确保图像和格式符合要求,借此让用户留下深刻印象。