After working for more than 5 years in the field of Development I started realizing the importance of Documentation, and hence I thought to write on documenting README.md file.
Here are some of the patterns I personally follow and made it a mandate to my team after creating a new repository or before committing codebase in existing repository, have a look at my README.md and markdown all informative notes.
These services are part of Blah Blah Blah Project.
Before committing code please ensure,
- README.md is updated
- A successful build and jar is deployed on nexus
- All newly implemented APIs are documented
- All newly added properties are documented in additional-spring-configuration-metadata.json
- Spring Boot 1.5.1.RELEASE
- Custom: Exceptions, File IO, Rest Authentication
- Spring Boot Test
- JSON Library(javax.json)
- Swagger API
- Hibernate Validation API (org.hibernate)
- Random Numbers and String Generators(smt-random-strings and smt-random-numbers)
These services can perform,
- Employee CRUD operations.
A step by step series of examples that tell you how to get a development env running
Add additional notes about how to deploy this on a live system
Add all JIRA Tickets with Hyperlinks
- 1.0-SNAPSHOT: Contains Add, View, Update, and Delete Employees
- Pratik Ambani(Pratik.firstname.lastname@example.org)
A short snippet describing the license (MIT, Apache etc)
As usual, suggestions are always welcomed. Happy Coding and may the code bless you. 😇
TIP: Keep your README.md updated if you believe in KARMA. 😉