docs(SETUP): document fifo sorting

nikku · Jan 10, 2024 · 3ef92f1 · 3ef92f1
1 parent 1152db6
commit 3ef92f1
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 7 deletions.
diff --git a/docs/SETUP.md b/docs/SETUP.md
@@ -94,8 +94,8 @@ module.exports = {
     { name: 'Inbox', label: null },
     { name: 'Backlog', label: 'backlog', sorting: true },
     { name: 'Ready', label: 'ready', sorting: true },
-    { name: 'In Progress', label: 'in progress' },
-    { name: 'Needs Review', label: 'needs review' },
+    { name: 'In Progress', label: 'in progress', sorting: true },
+    { name: 'Needs Review', label: 'needs review', sorting: true, fifo: true },
     { name: 'Done', label: null, closed: true }
   ]
 };
@@ -134,9 +134,16 @@ module.exports = {
 Column mappings enable [automatic card movement](./AUTOMATIC_CARD_MOVEMENT.md) across the board as you develop.
 
 
-### Issue Links and Automatic Sorting
+### Column Ordering
 
-Board columns can sorted automatically, based on [sematic issue links](./ISSUE_LINKS.md). Enable this feature for individual columns by marking them as `sorting`.
+Per default issues in a column will be ordered _last in, first out_. This means that, unless they are explicitly sorted into a column, new issues are added on top of existing ones in a column.
+
+To change this to _first in, first out_ mark a column as `fifo`. New items will now end up at the bottom of a column. Useful, i.e. for review columns.
+
+
+### Issue Links and Semantic Sorting
+
+In addition to [default ordering](#column-ordering) board columns can be sorted based on [semantic issue links](./ISSUE_LINKS.md). Enable this feature for a column by marking it as `sorting`.
 
 
 ## Run in Production

diff --git a/packages/app/wuffle.config.example.js b/packages/app/wuffle.config.example.js
@@ -15,6 +15,8 @@
  *  * closed     - if the column issues must be closed
  *  * sorting    - true if column cards should be sorted
  *                 incrementally based on links
+ *  * fifo       - true to turn the default column ordering from
+ *                 last in first out to first in first out
  *  * states     - a list of board states to map to this column
  *
  * The default column is the column that holds open issues without
@@ -33,9 +35,9 @@ module.exports = {
   columns: [
     { name: 'Inbox', label: null },
     { name: 'Backlog', label: 'backlog', sorting: true },
-    { name: 'Ready', label: 'ready', sorting: true },
-    { name: 'In Progress', label: 'in progress', sorting: true },
-    { name: 'Needs Review', label: 'needs review', sorting: true },
+    { name: 'Ready', label: 'ready', sorting: true, fifo: true },
+    { name: 'In Progress', label: 'in progress', sorting: true, fifo: true },
+    { name: 'Needs Review', label: 'needs review', sorting: true, fifo: true },
     { name: 'Done', label: null, closed: true }
   ],