diff --git "a/\347\254\254\344\270\200\351\203\250\345\210\206\357\274\232\345\210\235\350\257\206\345\274\200\346\272\220/\347\254\254 6 \345\260\217\350\212\202\357\274\232\345\270\270\350\247\201\346\226\207\344\273\266\350\256\244\350\257\206.md" "b/\347\254\254\344\270\200\351\203\250\345\210\206\357\274\232\345\210\235\350\257\206\345\274\200\346\272\220/\347\254\254 6 \345\260\217\350\212\202\357\274\232\345\270\270\350\247\201\346\226\207\344\273\266\350\256\244\350\257\206.md" index 83fcb22aa1deff268ad7695d31bfaccbec21fc6f..d596e2790199962558838d05745cd5945ddd8ca3 100644 --- "a/\347\254\254\344\270\200\351\203\250\345\210\206\357\274\232\345\210\235\350\257\206\345\274\200\346\272\220/\347\254\254 6 \345\260\217\350\212\202\357\274\232\345\270\270\350\247\201\346\226\207\344\273\266\350\256\244\350\257\206.md" +++ "b/\347\254\254\344\270\200\351\203\250\345\210\206\357\274\232\345\210\235\350\257\206\345\274\200\346\272\220/\347\254\254 6 \345\260\217\350\212\202\357\274\232\345\270\270\350\247\201\346\226\207\344\273\266\350\256\244\350\257\206.md" @@ -14,16 +14,16 @@ 说明文件一般会在项目的顶层目录列出，用来提供项目介绍、使用说明、变更记录、参与者及使用者说明等。下面列举几种常见的说明文件： -- **AUTHORS**：贡献者列表，记录项目的贡献者。 +- **README**：项目介绍说明文件，通常包含简要说明、安装方法、使用方法、贡献指南、常见问题解答等信息。 +- **LICENSE**：开源许可证文件，用于明确说明项目的授权方式和使用条款。一个开源项目通常会选择一种开源协议，如 GPL、Apache、MIT 等。 +- **NOTICE**：通常用于列出项目所使用的第三方库、依赖、软件工具或其他知识产权声明。帮助用户和客户了解项目所依赖的其他组件的许可证和版权信息。 +- **CONTRIBUTING**：指导参与者如何对项目做出贡献，通常包括如何向项目贡献代码、报告问题、提交建议等作业流程。 +- **AUTHORS** 或 **CONTRIBUTORS**：贡献者列表，记录项目的贡献者名单。这对于表彰贡献者的劳动成果非常重要。 - **DISCLAIMER**：免责声明文件。 - -- **CHANGELOG**：CHANGELOG 文件用来记录项目的变更记录，通常包含 Added、Changed、Removed 和 Fixed。 -- **CODE_OF_CONDUCT**：行为准则文件. 行为准则定义了如何在社区中进行交互和交流的最佳实践, 它也可以作为解决社区成员之间冲突的首选文件。 -- **CODEOWNERS**：代码所有者，代码所有者文件是 Github 提供的特性，可以指定文件或目录的代码所有者，当文件或目录出现 PR 时，可以推送给代码所有者，提醒进行 PR 审查。 -- **CONTRIBUTING**：指导参与者如何对项目做出贡献，CONTRIBUTING 中表述了项目需要什么类型的贡献，社区或者本项目的作业流程。 -- **LICENSE**：开源许可证文件，开源项目通过编写开源许可文件，声明项目使用的开源协议。 -- **NOTICE**：用来存放 License 定义的法律声明文件。 -- **README**：项目介绍说明文件，通常 README 会表述项目的用处、发起原因、快速使用等。 +- **CHANGELOG**：用来记录项目的变更记录，通常包含 Added、Changed、Removed 和 Fixed 等内容。可帮助用户快速了解项目的演进以及各版本间的差异。 +- **CODE_OF_CONDUCT**：行为准则文件，用于规范项目社区成员的行为准则。通常定义了如何在社区中进行交互和交流的最佳实践, 它也可以作为解决社区成员之间冲突的首选文件。 +- **CODEOWNERS**：代码所有者，代码所有者文件是 GitHub 提供的特性，可以指定文件或目录的代码所有者，当文件或目录出现 PR 时，可以推送给代码所有者，提醒进行 PR 审查。 +- **TODO**：项目待办事项文件，通常包含项目的开发计划、待办事项、改进想法等内容，帮助参与者了解项目的发展方向和优化空间。 需要注意的是，上述文件仅作为项目开源的指导性文件，属于约定俗成的开源项目规范，并非强制要求，请根据自身需求选择使用相应的文件。当然，你也可以按照自己的想法制定自己的项目规范，只要能够帮助项目在开源过程中的能够很好的管理、开发和维护，能够保障项目相关权利，它就是一份良好的项目规范。