Add metadata documentation #2547
Conversation
|
but why not put this info into the README or in a doc named "how to write tests" (working title) |
I like more the idea of the "how to write tests" as I find that the README would get too big if we include the entire schema + table. Additionally, the information of this file is more technicalities than a general purpose read that a README represents. But yes, even knowing of the existence of the file it was hard to find in the explorer, so a rename would be nice 😅. |
+1. |
|
Then rename it to HOW_TO_WRITE_FEATURE_DETECTS.md :-) |
Also changed the header levels to accomodate the new title/purpose
|
Done, I also changed the header levels, because the title implies that in some day there will be other subjects apart from metadata |
|
is the doc going to be updated to be about how to write feature detects, then? it doesn't really mention that at all... |
|
Okay, I'll add some title and description later in the day, writing Markdown in mobile would be horrible 😅 |
|
thanks @MarkelFe!! |
This reverts commit 98005b1.
|
I made it a little vague because I'm not entirely sure which kind of information could go in this file, once it grows the statement could probably be more precise. I've based the table of contents style from the atom contributing guidelines. Also, sorry for the commit mess, I had just configured my GPG key on git and vscode and one commit went with the wrong email address. |
Codecov Report
@@ Coverage Diff @@
## master #2547 +/- ##
=========================================
Coverage ? 95.15%
=========================================
Files ? 5
Lines ? 165
Branches ? 0
=========================================
Hits ? 157
Misses ? 8
Partials ? 0 Continue to review full report at Codecov.
|
|
@patrickkettner everything right with the PR? |
|
Last chance for @patrickkettner to object before I merge it tomorrow :-) |
I found out that there was no documentation for the metadata of the files, so I created a little Markdown file explaining what every piece of metadata represents + putting all of them together, as all the detects don't have the same amount of metadata.
I didn't know where to put this information, so I created a new file, feel free to suggest any other location.
There is also some of them that I don't know their functionality, I'll comment them on line comments.