From 1e67e7784cc4a36d80b9b53b7d6257945cf85f65 Mon Sep 17 00:00:00 2001 From: tobiichi3227 Date: Tue, 3 Dec 2024 23:06:25 +0800 Subject: [PATCH] Docs: Update CONTRIBUTING.md --- CONTRIBUTING.md | 33 ++++++++++++++++++++++++++++++--- 1 file changed, 30 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a9d9c5a..818d7e3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -34,16 +34,43 @@ 4. Maintain a positive and encouraging tone. ### Special Events +#### Date Structure +##### Static Date +1. With year, month and date + ```json + "triggerDate": { + "year": "Year", + "month": "Month", + "date": "Date" + } + ``` +##### Cyclical Date +1. With only month and day + ```json + "triggerDate": { + "month": "Month", + "date": "Date" + } + ``` + +2. With only month, week, weekday (like Mother's Day) + ```json + "triggerDate": { + "month": "Month", + "week": "Week", + "weekday": "Weekday" + } + ``` + +#### Event Structure Special events require a more detailed structure. 1. Structure: ```json { "event": "Event Name", - "year": "Year", - "month": "Month", - "date": "Date", + "triggerDate": {}, // Please refer to explaination above "status_index": "Status Index", "goodFortunes": { "l_1_event": "Good Fortune 1",