commit ed63c7230d97996cba91b68d64371ba409da5a4f
parent 93bffbe0b66f8ee622ddd66e2130594bb2a91788
Author: Juan F. Meleiro <juan@juanmeleiro.mat.br>
Date: Fri, 6 Jun 2025 13:17:40 -0300
Add checklist for weekly report
Diffstat:
4 files changed, 125 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md
@@ -43,6 +43,8 @@
- Messages where a player is deactivated (R2646)
- Reactivation
- Messages where a player reactivates emself (R2646)
+ - CoEs
+ - Messages containing claims of error on the Registrar's reports. (R2201)
- Changes
- Messages in which pertinent rules are changed.
diff --git a/checklists/index.md b/checklists/index.md
@@ -1,3 +1,65 @@
# Checklists
- [Registration](registration.txt)
+- [Weekly report](weekly-report.txt)
+- Inactive players
+- Monthly report
+- Deregistration
+- Change in Activity
+- Cantus Cygnei
+- CoEs
+
+## Sketch
+- Weekly report
+ - When? Once a week
+ - Routine:
+ - Generate
+ - Send
+ - Archive (save copy and record in log)
+
+- Monthly report
+ - When? Once a month
+ - Routine:
+ - Generate
+ - Send
+ - Archive (save copy and record in log)
+
+- Writs
+ - When? When a cantus is received.
+ - Routine:
+ - Publish writ
+ - Record in log and players.json
+
+- Record new players
+ - When? When player registers
+ - Routine:
+ - Record in log and players.json
+
+- Record departing players
+ - When? When player deregisters or is deregistered
+ - Routine:
+ - Record in log and players.json
+
+- Record banned players
+ - When? When players are banned
+ - Routine:
+ - Record in log and players.json
+
+- Deactivate players
+ - When? N days after last public message
+ - Routine:
+ - Record in log and players.json
+
+- Intent to deregister players
+ - When? N days after deactivation
+ - Routine:
+ - Send message putting forth intent
+ - Record in log and players.json
+
+- Deregister players
+ - When? When intent is ripe and mature
+ - Routine:
+ - Send message deregistering players
+ - Record in log and players.json
+
+
diff --git a/checklists/weekly-report.txt b/checklists/weekly-report.txt
@@ -0,0 +1,60 @@
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+ WEEKLY REPORT
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+————————————————————————————————————————
+ 1 Conditions
+————————————————————————————————————————
+
+Either:
+
+- It's time to publish the current's
+ week report.
+
+- You accepted a CoE and need to
+ republish the report.
+
+————————————————————————————————————————
+ 2 Actions
+————————————————————————————————————————
+
+Working tree ..................... CLEAN
+ Verify git working tree is clean
+ of changes.
+
+Command ............................ RUN
+ See output of command:
+ ./registrar weekly -h
+
+News .............................. EDIT
+ Edit the news section in the
+ temporary buffer that was opened in
+ the programmed $EDITOR to include
+ your message.
+
+ It is pre-filled with events from
+ the log and commits in the repo.
+
+ Save the changes and close the
+ editor.
+
+Message ........................... SEND
+ Send the message using your mail
+ client.
+
+Changes ......................... COMMIT
+ Commit changes to git with a
+ descriptive message like
+ “Weekly report”.
+
+Inactive players ................. CHECK
+ If there are players inactive for
+ 60 days or more, perform the
+ Inactive Players checklist.
+
+Check .............................. RUN
+ ./registrar check
+
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+ FIM
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
diff --git a/lib/check.lua b/lib/check.lua
@@ -4,6 +4,7 @@ local check = function(args, players, log)
os.exit(0)
-- luacheck
-- check documentation is covering
+ -- check archive has files with proper names for all weeks
end
return check
