guidelines/hierarchy.md

@@ -72,11 +72,13 @@ Your test suite goes here.  How to structure files under this directory
 will most probably depend on the test framework you use.
 
 
-### artifacts ###
+### relics ###
 
-If your test suite creates files that you usually need to review,
-this is a good place.  Subdirectories here should bear a timestamp in
-a human-readable and sortable timestamp format (such as ISO 8601).
+Place for locally ran tests to drop any results, reports and intermediate
+files that would be useful for investigating test failures.
+
+Subdirectories here should bear a timestamp in a human-readable and
+sortable timestamp format (such as ISO 8601).
 
 Note that normally this directory will never exist in a freshly cloned
 repository and it's likely to be excluded from version control system
@@ -86,13 +88,13 @@ via file such as *.gitignore*.
 ### notes ###
 
 Documentation related to your project.  Evertything from guidelines to
-newcomer howtos, style guides, design notes, philpsophy articles...
+newcomer howtos, style guides, design notes, philosophy articles...
 
 
 ### utils ###
 
 Any build scripts and utilities that are only useful for your project
-developers and testers.
+developers, maintainers and testers.
 
 
 ### packaging ###
@@ -106,7 +108,7 @@ e.g. creating unofficial .deb files.
 
 [MKit][1] already provides features that can help generate such files.
 
-  [1]: https://github.com/AloisMahdal/mkit
+  [1]: https://gitlab.com/vornet/infra/mkit
 
 
 Example
@@ -118,19 +120,6 @@ A "living" example: [shellfu][2]:
     ├── LICENSE             # \
     ├── Makefile            #  Pretty much standard files...
     ├── README.md           # /
-    ├── artifacts
-    │   ├── artifacts-inigrep_inigrep-20161202-073432
-    │   │   ├── TF_ENUMERATED_SUBTESTS
-    │   │   ├── TF_FILTERED_SUBTESTS
-    │   │   ├── TF_RUN
-    │   │   ├── oracle      # \
-    │   │   │   └── ...     #   artifacts are now huge since 
-    │   │   ├── result      #   I ran a lot of tests recently
-    │   │   │   └── ...     # /
-    │   │   └── test
-    │   │       └── ...
-    │   └── artifacts-shellfu_api-20161202-081440
-    │       └── ...
     ├── mkit.ini            # <- MKit meta-data file
     ├── notes               # <- my design notes, although
     │   └── style.md        #    most are still in my head :)
@@ -140,6 +129,19 @@ A "living" example: [shellfu][2]:
     │   │   ├── control     #   alpha RPMs and .deb's
     │   │   └── ...         #   (so far, probably for good)
     │   └── shellfu.spec    # /
+    ├── relics
+    │   ├── relics-inigrep_inigrep-20161202-073432
+    │   │   ├── TF_ENUMERATED_SUBTESTS
+    │   │   ├── TF_FILTERED_SUBTESTS
+    │   │   ├── TF_RUN
+    │   │   ├── oracle      # \
+    │   │   │   └── ...     #   relics are now huge since 
+    │   │   ├── result      #   I ran a lot of tests recently
+    │   │   │   └── ...     # /
+    │   │   └── test
+    │   │       └── ...
+    │   └── relics-shellfu_api-20161202-081440
+    │       └── ...
     ├── src
     │   ├── bin                     # \
     │   │   ├── shellfu-doc         #   here most of the "meat" lives,
@@ -148,7 +150,7 @@ A "living" example: [shellfu][2]:
     │   ├── complete.bash           #
     │   ├── include-bash            #   notice that tree here does
     │   │   └── ...                 #   not attempt to strictly follow
-    │   ├── include-sh              #   final placement, jsut hinting
+    │   ├── include-sh              #   final placement, just hinting
     │   │   └── ...                 #   is enough
     │   └── shellfu.sh.skel         # /
     ├── tests                   # \
@@ -166,4 +168,4 @@ A "living" example: [shellfu][2]:
         └── tfkit       #   from the suite (they meet often, though ;))
             └── ...     # /
 
-  [2]: https://github.com/AloisMahdal/shellfu
+  [2]: https://gitlab.com/vornet/shellfu/shellfu