Taking README.md to the next level - Githubissues

ungdev / etuutt-api

Users, classes, assos : An awesome API to rule them all

MIT License

2 stars 2 forks source link

Taking README.md to the next level #21

Closed ThomasRitaine closed 2 years ago

ThomasRitaine commented 2 years ago

Description

Adding a new README that follows a lot of good conventions.

Checklist

Test

Implementation

[x] Files and variables have a name explaining what they do.
[x] Updating the DB schemas and seeding the tables do not generates errors.
[x] All code repeted more than 2 times has been refactored in a dedicated file or function.
[x] Debugs have been removed : dd() | dump()

Tools

[x] PHP CS Fixer has fixed all files inside the src folder.
[x] All commits have been done using Commitizen.

Documentation

[x] All new classes and non-trivial functions have a code documentation.
[x] There are comments to explain complex parts inside your code.
[x] If a new folder is created, it has been added and explained inside the "Folder structure" part of the README.md file.