From a193f249186657e5ca1d479e5d2176ad79c092a4 Mon Sep 17 00:00:00 2001 From: Randy Olson Date: Fri, 9 Oct 2026 11:26:22 -0700 Subject: [PATCH] Allow sharing save links by email Issues, pull requests, and the repository still never hold saves or links to them. Reporters may optionally email a save link to the maintainer. Refs #20 Co-Authored-By: Claude Opus 5.5 --- .github/ISSUE_TEMPLATE/bug.yml | 4 ++-- .github/ISSUE_TEMPLATE/unsupported-save.yml | 4 ++-- CONTRIBUTING.md | 5 +++-- README.md | 8 ++++---- docs/guides/trust.md | 5 +++-- tests/test_readme.py | 7 ++++--- 6 files changed, 18 insertions(+), 15 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index 4015e18..18adfc6 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -5,13 +5,13 @@ body: - type: markdown attributes: value: | - Do not attach save files or screenshots, and do not paste real player, staff, club or competition names, uids or values. Describe the problem in general terms. `fmsave validate SAVE --json` prints no names, uids or text from the save, so its output is safe to paste. + Do not attach save files or screenshots, and do not paste real player, staff, club, or competition names, uids, or values. Describe the problem in general terms. `fmsave validate SAVE --json` prints no names, uids, or text from the save, so its output is safe to paste. To share a save, email a link to the address on [the maintainer's GitHub profile](https://github.com/rhiever). - type: checkboxes id: no-real-data attributes: label: No save files or real data options: - - label: I have not attached a save file, screenshot or any real player data + - label: I have not attached or linked a save file, screenshot, or any real player data required: true - type: textarea id: problem diff --git a/.github/ISSUE_TEMPLATE/unsupported-save.yml b/.github/ISSUE_TEMPLATE/unsupported-save.yml index 0d483d0..40c4087 100644 --- a/.github/ISSUE_TEMPLATE/unsupported-save.yml +++ b/.github/ISSUE_TEMPLATE/unsupported-save.yml @@ -5,13 +5,13 @@ body: - type: markdown attributes: value: | - Do not attach save files or screenshots, and do not paste real player, staff, club or competition names, uids or values. Error messages name the save file, so replace its name with `career.fm` before pasting. + Do not attach save files or screenshots, and do not paste real player, staff, club, or competition names, uids, or values. Error messages name the save file, so replace its name with `career.fm` before pasting. To share a save, email a link to the address on [the maintainer's GitHub profile](https://github.com/rhiever). - type: checkboxes id: no-real-data attributes: label: No save files or real data options: - - label: I have not attached a save file, screenshot or any real player data + - label: I have not attached or linked a save file, screenshot, or any real player data required: true - type: textarea id: problem diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 15cdf65..9db090c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -48,5 +48,6 @@ You can report a wrong value without sharing any real data: 2. Name the field, such as `Player.contract.end` or the `contract_end` column. `fmsave.field_status(fmsave.Player, "contract.end")` tells you whether its meaning is verified or unconfirmed. 3. Describe what the game shows in general terms. For example: "for a few players at my club, the game shows a contract end date one year later than fmsave". Leave out names, uids and exact values. -Use the bug report form for this. Never attach a save file or a screenshot. Maintainers will never -request or accept a save file. +Use the bug report form for this. Do not attach or link a save file or screenshot in the issue. +Sharing a save is optional but speeds up fixes: email a link to the address on +[the maintainer's GitHub profile](https://github.com/rhiever) and say in the issue that you sent one. diff --git a/README.md b/README.md index cd56db4..e0a25f3 100644 --- a/README.md +++ b/README.md @@ -125,10 +125,10 @@ shared online career may break platform or community rules. ## Support fmsave is a hobby project, maintained on a best-effort basis. Report problems through -[GitHub issues](https://github.com/rhiever/fmsave/issues). Never attach a save file; maintainers -will not request or accept one. See [CONTRIBUTING.md](CONTRIBUTING.md) for how to report a wrong -value without sharing real data. To request removal of any content, open an issue with the rights -request form. +[GitHub issues](https://github.com/rhiever/fmsave/issues). Do not attach or link a save file in an +issue. To share a save, email a link to the address on [my GitHub profile](https://github.com/rhiever). +See [CONTRIBUTING.md](CONTRIBUTING.md) for how to report a wrong value without sharing real data. To +request removal of any content, open an issue with the rights request form. ## Disclaimer diff --git a/docs/guides/trust.md b/docs/guides/trust.md index 44134e9..1438651 100644 --- a/docs/guides/trust.md +++ b/docs/guides/trust.md @@ -85,8 +85,9 @@ game FM26, build 26.1.0+1234567 ``` The report contains checks, counts and rates, without names, uids or text from your save. Paste it -into a [GitHub issue](https://github.com/rhiever/fmsave/issues) when a reader misbehaves. Never -attach the save file itself. +into a [GitHub issue](https://github.com/rhiever/fmsave/issues) when a reader misbehaves. Do not +attach or link the save itself. To share it, email a link to the address on +[the maintainer's GitHub profile](https://github.com/rhiever). ## Money and game builds diff --git a/tests/test_readme.py b/tests/test_readme.py index 0435d64..d9b59f4 100644 --- a/tests/test_readme.py +++ b/tests/test_readme.py @@ -244,6 +244,7 @@ def test_whole_save_analysis_keeps_the_explicit_gate_and_online_warning() -> Non assert "`--all` is explicit" in command_line_text -def test_support_never_requests_or_accepts_save_files() -> None: - support_text = readme_section("## Support") - assert "not request or accept one" in support_text +def test_support_keeps_saves_out_of_issues_and_offers_email() -> None: + support_text = " ".join(readme_section("## Support").split()) + assert "Do not attach or link a save file in an issue" in support_text + assert "email a link" in support_text