Files

T

JonKazama-Hellion d63c710836 docs: restructure into docs/ folder, add roadmap and learning notes

- Move AI_DISCLOSURE, THIRD_PARTY_NOTICES, UPSTREAM_SYNC, ipc.md
  into docs/ (ipc.md renamed to IPC.md for consistency)
- Add docs/ROADMAP.md, docs/CHANGELOG.md, docs/CONTRIBUTORS.md,
  docs/LEARNING-JOURNEY.md
- Update README to reflect the v1.0.0 standalone state, drop the
  development section, refresh the architecture tree, add a
  release-cadence block linking to LEARNING-JOURNEY
- Fix stale ChatTwo/* source paths to HellionChat/* across docs
- Update cross-links in PRIVACY, CONTRIBUTING and .github/* so they
  point at the new docs/ paths

Pure documentation pass, no code changes.

2026-05-04 09:03:59 +02:00

5.5 KiB

Raw Permalink Blame History

Contributing to HellionChat

Thanks for taking a look. HellionChat is a small, opinionated fork of Chat 2 maintained by one person in spare time. This document explains what I am looking for, what I am not, and how to make a contribution land smoothly.

Before you open anything

Read the README so you understand the scope: this is a privacy-focused, EUPL-1.2-licensed Dalamud plugin that intentionally removes the upstream webinterface and ships smaller defaults.
Read UPSTREAM_SYNC.md. Cherry-picks from upstream Chat 2 are selective and conscious; not everything that lands there belongs here.
Read SECURITY.md. Anything security-sensitive goes through a private advisory, never a public issue or PR.
Read the code of conduct.

What I will accept

Bug fixes for behaviour documented in the README, the in-plugin settings or the changelog.
Translation contributions for Hellion-specific strings via direct pull requests against HellionChat/Resources/HellionStrings.*.resx. Translations for the upstream Chat 2 strings (Language.*.resx) are not handled here; they go through the upstream Chat 2 project.
Documentation improvements (README, comments, this file).
Performance fixes with a measurable before/after.
New features that fit the privacy-first scope and do not duplicate what an existing Dalamud plugin already does well.

What I will probably decline

Re-introducing the webinterface or any remote-access feature. It was removed in v0.2.0 on purpose. See README "Was gegenüber Chat 2 fehlt".
Features that bypass the privacy filter or weaken the default retention behaviour without an explicit, documented opt-in.
Sweeping refactors that touch large parts of the upstream codebase. They make selective upstream cherry-picks much harder and the maintenance cost outweighs the benefit for a one-person project.
AI-generated code dropped in without disclosure or human review. See AI_DISCLOSURE.md for how I handle AI assistance on my side; I expect comparable transparency from contributors.

If you are unsure whether an idea fits, open a feature-request issue first and ask before writing code. I would rather say "no" to a proposal than to a finished pull request.

Workflow

Open an issue (bug or feature request) using the templates under .github/ISSUE_TEMPLATE/. Skip this step only for trivial typos.
Fork the repository and branch off main. Branch naming is informal; something like fix/auto-tell-history-empty or feat/adblock-light-mode is plenty.
Match the existing code style. The repository ships an .editorconfig that VS Code and Rider pick up automatically.
Keep commits focused. Several small commits with clear messages are easier to review than one big one. Squash-on-merge happens at the PR level if needed.
If your change touches user-visible behaviour, update the README and/or the changelog block in HellionChat/HellionChat.yaml and repo.json for the next version. I bump the version number myself at release time, so you do not need to.
Open the pull request against main. The PR template will ask you to summarise the change, the testing you did and any compatibility notes.

Build and test

The project targets net10.0-windows against Dalamud SDK 15. To build locally you need:

.NET 10 SDK
A working Dalamud development environment with DALAMUD_HOME set (XIVLauncher installed and launched once is the simplest path)
VS Code with the C# Dev Kit, Rider, or Visual Studio

dotnet restore
dotnet build HellionChat.sln -c Release

Tests are not part of the current HellionChat.sln. If you add a test project, point it at the relevant subsystems (privacy filter, configuration migration, message store) and mention it in the PR.

For a smoke test in-game: build, copy the output into your Dalamud devPlugins/HellionChat/ directory and load it through /xlplugins.

Continuous integration

Every push and every pull request runs:

build.yml — dotnet build and dotnet test
codeql.yml — CodeQL security analysis

A pull request will not be merged while either of these is failing. CodeQL findings on changed code need to be addressed; pre-existing findings on untouched code are tracked separately.

Licensing

By submitting a pull request you confirm that:

Your contribution is your own work, or you have the right to contribute it under the project licence.
You agree that your contribution will be released under the EUPL-1.2, the same licence as the rest of the project.

There is no separate CLA.

Translations

Hellion-specific strings live in HellionChat/Resources/HellionStrings.resx (English source) and HellionStrings.<lang>.resx (per-language). Translations are accepted as direct pull requests against those files.

The upstream Chat 2 strings in HellionChat/Resources/Language.*.resx are not translated in this repository. They are owned by the upstream Chat 2 project and synced in via cherry-pick. Please contribute upstream-string translations to Infiziert90/ChatTwo instead.

A note on response times

I respond on weekdays during European business hours and I take weekends and FFXIV patch days off. A pull request that sits for a few days has not been ignored; I just have not gotten to it yet. Pinging once after a week is fine; please do not ping daily.

5.5 KiB Raw Permalink Blame History