一份有意义的 README.md 文件

部署

在开发领域工作了 5 年多之后，我开始意识到文档的重要性，因此我决定写一篇关于编写 README.md 文件文档的文章。

以下是我个人遵循的一些模式，并已强制要求我的团队在创建新存储库后或在现有存储库中提交代码库之前，查看我的 README.md 和 markdown 所有信息注释。

项目名称

这些服务是“Blah Blah Blah 项目”的一部分。

屏幕

顺便告诉大家，你们也可以在 (readme.md)markdown 文件中添加 gif 图片。

在你做出决定之前

提交代码前请确保：

• README.md 已更新
• 构建成功，jar 文件已部署到 Nexus。
• 所有新实现的API都有文档记录。
• 所有新增属性均记录在 additional-spring-configuration-metadata.json 文件中。

使用的库

1. Spring Boot 1.5.1.RELEASE
2. 自定义：异常、文件 I/O、REST 身份验证
3. Spring Boot 测试
4. JSON 库（javax.json）
5. Swagger API
6. Hibernate 验证 API (org.hibernate)
7. 随机数和字符串生成器（smt-random-strings 和 smt-random-numbers）

特征

这些服务可以执行以下操作：

1. 员工CRUD操作。

安装

一系列循序渐进的示例，教你如何搭建一个运行中的开发环境。

部署

添加关于如何在生产系统中部署此功能的补充说明

JIRA 参考资料

添加所有带有超链接的 JIRA 工单

版本

1. 1.0-SNAPSHOT：包含添加、查看、更新和删除员工功能

开发者

• 普拉蒂克·安巴尼（Pratik.ambani@companydomain.com）

执照

简要说明许可证（MIT、Apache 等）

一如既往，欢迎提出建议。祝您编程愉快，愿代码带给您祝福。😇

提示：如果你相信因果报应，请及时更新你的 README.md 文件。😉