From d85d524fca62c8b0b684d826379136e2ea6f06bb Mon Sep 17 00:00:00 2001 From: Wexx <86693821+wexxlee@users.noreply.github.com> Date: Wed, 10 Jul 2024 10:47:27 -0700 Subject: [PATCH] docs: minor updates (#220) --- CONTRIBUTING.md | 12 ++++---- docs/PatchUpdateChecklist.md | 54 +++++++++++++++++++++++------------- 2 files changed, 42 insertions(+), 24 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0626c50603..8e030051fa 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,13 +5,15 @@ * [Code of Conduct](#code-of-conduct) * [Issues and Bug Reports](#issues-and-bug-reports) * [Pull Requests](#pull-requests) + * [Development Workflow](#development-workflow) + * [Code Review Culture](#code-review-culture) * [Coding Style](#coding-style) * [Desired Features](#desired-features) * [Trigger Guidelines](#trigger-guidelines) - * [Trigger Severity](#trigger-severity) - * [Trigger Text](#trigger-text) * [Timeline Guidelines](#timeline-guidelines) -* [Roadmap](#roadmap) +* [Oopsy Guidelines](#oopsy-guidelines) +* [Markdown Guidelines](#markdown-guidelines) +* [How to Release](#how-to-release) ## Code of Conduct @@ -182,8 +184,8 @@ See these links: ## Coding Style -The ideal end state is that all C#, Python, and Javascript code is linted and autoformatted. -The current state is that Javascript and Python are fairly well linted +The ideal end state is that all C# and Javascript code is linted and autoformatted. +The current state is that Javascript is fairly well linted (although variable naming conventions are all over the place) and C# is not very consistent. Over time, it would be nice to move towards that ideal state. diff --git a/docs/PatchUpdateChecklist.md b/docs/PatchUpdateChecklist.md index c2ab9a7df9..bafaee9c3e 100644 --- a/docs/PatchUpdateChecklist.md +++ b/docs/PatchUpdateChecklist.md @@ -2,6 +2,24 @@ This is a guide for steps to update cactbot when FFXIV has a patch. +## Table of Contents + +* [Game Data Resource Updates](#game-data-resource-updates) + * [Run update scripts](#run-update-scripts) + * [effect_id data](#effect_id-data) + * [hunt data](#hunt-data) + * [zone_id & zone_info data](#zone_id--zone_info-data) + * [Update Content List](#update-content-list) +* [Create a Meta-issue to Track Content Work](#create-a-meta-issue-to-track-content-work) +* [In Game Memory Verification](#in-game-memory-verification) + * [Check memory signatures](#check-memory-signatures) + * [memtest overlay](#memtest-overlay) + * [Verify Job data](#verify-job-data) +* [et voila, release](#et-voila-release) +* [Other Things](#other-things) + * [OverlayPlugin Changes](#overlayplugin-changes) + * [New Expansion - Tracking Cactbot Work](#new-expansion---tracking-cactbot-work) + ## Game Data Resource Updates Once the patch is downloadable, [XIVAPI](https://xivapi.com) will be updated @@ -252,9 +270,9 @@ cactbot has a number of memory signatures that it uses. There are four signatures, which all live in [FFXIVProcessIntl.cs](https://github.com/OverlayPlugin/cactbot/blob/main/plugin/CactbotEventSource/FFXIVProcessIntl.cs). -- Charmap (information about your character) -- Job Data (gauge info for your job) -- In Combat (whether the game thinks you are in combat) +* Charmap (information about your character) +* Job Data (gauge info for your job) +* In Combat (whether the game thinks you are in combat) OverlayPlugin also duplicates the charmap and in combat signatures, so if cactbot is broken please update those as well. @@ -334,26 +352,24 @@ Test at least one job with the cactbot jobs overlay and make sure boxes update. ## et voila, release Once the resources are updated and the signatures and memory data look good, -do a cactbot release! +[do a cactbot release](https://github.com/OverlayPlugin/cactbot/blob/main/CONTRIBUTING.md#how-to-release)! ## Other Things -It'd be nice to have a list of OverlayPlugin steps too, but that could live elsewhere. - -### New expansion changes +### OverlayPlugin Changes -When a new expansion releases, there are a variety of changes that will be needed -in various files to, e.g., support new jobs or account for job changes/re-works. -This is a partial working list of potential changes that may be needed: - -- Update buff tracker with job buff changes - See +It'd be nice to have a list of OverlayPlugin steps too, but that could live elsewhere. +As an example of an OverlayPlugin tracking issue for a full expansion release, +see . -- Add job icons - See & +### New Expansion - Tracking Cactbot Work -- Add new job enums - See +When a new expansion releases, in addition to adding support for a large amount of new content, +changes to existing code will almost certainly be necessary. +For example, support for new jobs will need to be added to virtually every module, and +changes to existing jobs will need to be accounted for. -- Add new expac to config files - See +It is strongly recommended to create a single tracking issue with a list of all tasks to be done, +and to keep the issue updated by linking to related PRs as they are submitted. +This maintains a single point of reference for future expansions and troubleshooting. +For example,