Skip to content

armgit / Pulse

Public Imported from GitHub
0

Real-time monitoring dashboard for Proxmox VE, PBS, Docker, Kubernetes, TrueNAS and vSphere. Self-hosted, with alerts for failed backups, full disks, unhealthy containers and offline nodes.

Keep offered patches as evidence and preserve contributor follow-through

pulse-triage[bot]a0ee068a6e82
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 5a20247976..202732a198 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -3,12 +3,18 @@ Thanks for taking the time to prepare a change.
Before submitting, please note:
- I am not accepting unsolicited external pull requests for this repository.
-- The normal contribution path is to open an issue or discussion first.
+- The normal contribution path is an issue or discussion, not a new pull
+ request. A diagnostic question is not a request for a pull request.
- PRs opened without prior maintainer direction may be closed without detailed
review.
-If this PR was opened in error, please close it and open an issue instead:
-https://github.com/rcourtman/Pulse/issues
+If you already have a tested patch or branch, link it as evidence in the existing
+issue; see [Sharing a tested patch](https://github.com/rcourtman/Pulse/blob/main/CONTRIBUTING.md#sharing-a-tested-patch).
+Do not duplicate an existing report or publish private logs, configuration or
+credentials. A patch is optional and does not guarantee acceptance.
-If this PR was explicitly requested by the maintainer for a tracked issue,
-include the issue number and the requested scope below.
+For a PR already requested in an earlier conversation, retain that issue link
+and the requested scope below. The maintainer owes it a reply and disposition
+in this thread; do not recreate the PR or refile its evidence. Include the
+source version, tests actually run and known limits. A source change or passing
+test does not establish release availability.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 3d397c1ce2..75445a4c3a 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -32,9 +32,17 @@ and installer tooling.
repository.
- Unsolicited pull requests may be closed without detailed review, even when the
underlying idea is valid.
-- If I want code help on a specific issue, I will explicitly ask for it there.
-- Opening an issue first is the right path; it lets me confirm whether the
- change fits the product direction before anyone spends time building a patch.
+- A report, diagnostic question or linked design is not an invitation to open
+ a pull request. You do not need to write a patch to report a problem.
+- If you already have a tested patch or branch, link it in the existing issue
+ as evidence, following [Sharing a tested patch](#sharing-a-tested-patch).
+ Maintainers handle implementation and source review through the project's
+ normal process; a supplied patch does not guarantee acceptance.
+- If a pull request already exists, especially one requested in an earlier
+ conversation, keep its link in that conversation. Do not recreate it or
+ refile evidence. It is owed a reply and a disposition in its own thread:
+ reviewed landing, or an equivalent maintainer fix with credit and a commit
+ link when the contribution is used.
## How To Make An Issue Useful
@@ -212,8 +220,10 @@ claims on the current documentation surface.
## Testing Expectations
-- Every requested PR should note the tests run (`go test`, frontend tests, or
- `scripts/tests/run.sh`, as applicable).
+- Source changes and supplied patch evidence should note the tests actually run
+ (`go test`, frontend tests, or `scripts/tests/run.sh`, as applicable), the
+ source version and any untested behaviour. A passing test is not proof that
+ a change is available in a published release.
- Add regression coverage when fixing bugs.
- Mention manual verification steps (e.g., “Proxmox LXC installer tested on
PVE 8.1”) if automated coverage is not feasible.
@@ -230,19 +240,22 @@ claims on the current documentation surface.
---
-## Submitting Requested Changes
-
-For maintainer-requested code help on a tracked issue:
-
-1. Link the issue where the maintainer requested the patch.
-2. Fork + branch (`git checkout -b feature/my-change`).
-3. Make your edits and run relevant tests.
-4. Update docs and changelog entries as needed.
-5. Open a PR describing:
- - What changed
- - Why it changed
- - Testing performed
- - Rollout / migration concerns
-
-Reviewers will focus on correctness, security, and upgrade paths, so call out
-anything unusual up front.
+## Sharing a tested patch
+
+If you already have a patch or branch, link it from the **existing issue**;
+do not open a new pull request to submit it. Include the source version, the
+reported behaviour it changes, tests actually run and known limits. Existing
+test results are useful; do not repeat an unsafe failure or run against a
+production installation just to prepare a patch. A patch is optional evidence,
+not a condition of reporting and not a promise that the change will be used.
+
+Review the linked branch, diff, logs and screenshots before sharing. Remove
+credentials, private configuration, diagnostics and identifying details; a
+public branch also exposes its commit history. Do not publish sensitive
+security evidence here; follow [SECURITY.md](SECURITY.md) instead.
+
+When a contribution is used, the fix reply credits its author and links the
+reviewed commit. A merged change is not necessarily in a published release;
+release availability and reporter confirmation remain separate facts. The
+development notes above are for local reproduction and validation, not an
+invitation to submit a pull request.
diff --git a/frontend-modern/public/docs/CONTRIBUTING.md b/frontend-modern/public/docs/CONTRIBUTING.md
index 3d397c1ce2..75445a4c3a 100644
--- a/frontend-modern/public/docs/CONTRIBUTING.md
+++ b/frontend-modern/public/docs/CONTRIBUTING.md
@@ -32,9 +32,17 @@ and installer tooling.
repository.
- Unsolicited pull requests may be closed without detailed review, even when the
underlying idea is valid.
-- If I want code help on a specific issue, I will explicitly ask for it there.
-- Opening an issue first is the right path; it lets me confirm whether the
- change fits the product direction before anyone spends time building a patch.
+- A report, diagnostic question or linked design is not an invitation to open
+ a pull request. You do not need to write a patch to report a problem.
+- If you already have a tested patch or branch, link it in the existing issue
+ as evidence, following [Sharing a tested patch](#sharing-a-tested-patch).
+ Maintainers handle implementation and source review through the project's
+ normal process; a supplied patch does not guarantee acceptance.
+- If a pull request already exists, especially one requested in an earlier
+ conversation, keep its link in that conversation. Do not recreate it or
+ refile evidence. It is owed a reply and a disposition in its own thread:
+ reviewed landing, or an equivalent maintainer fix with credit and a commit
+ link when the contribution is used.
## How To Make An Issue Useful
@@ -212,8 +220,10 @@ claims on the current documentation surface.
## Testing Expectations
-- Every requested PR should note the tests run (`go test`, frontend tests, or
- `scripts/tests/run.sh`, as applicable).
+- Source changes and supplied patch evidence should note the tests actually run
+ (`go test`, frontend tests, or `scripts/tests/run.sh`, as applicable), the
+ source version and any untested behaviour. A passing test is not proof that
+ a change is available in a published release.
- Add regression coverage when fixing bugs.
- Mention manual verification steps (e.g., “Proxmox LXC installer tested on
PVE 8.1”) if automated coverage is not feasible.
@@ -230,19 +240,22 @@ claims on the current documentation surface.
---
-## Submitting Requested Changes
-
-For maintainer-requested code help on a tracked issue:
-
-1. Link the issue where the maintainer requested the patch.
-2. Fork + branch (`git checkout -b feature/my-change`).
-3. Make your edits and run relevant tests.
-4. Update docs and changelog entries as needed.
-5. Open a PR describing:
- - What changed
- - Why it changed
- - Testing performed
- - Rollout / migration concerns
-
-Reviewers will focus on correctness, security, and upgrade paths, so call out
-anything unusual up front.
+## Sharing a tested patch
+
+If you already have a patch or branch, link it from the **existing issue**;
+do not open a new pull request to submit it. Include the source version, the
+reported behaviour it changes, tests actually run and known limits. Existing
+test results are useful; do not repeat an unsafe failure or run against a
+production installation just to prepare a patch. A patch is optional evidence,
+not a condition of reporting and not a promise that the change will be used.
+
+Review the linked branch, diff, logs and screenshots before sharing. Remove
+credentials, private configuration, diagnostics and identifying details; a
+public branch also exposes its commit history. Do not publish sensitive
+security evidence here; follow [SECURITY.md](SECURITY.md) instead.
+
+When a contribution is used, the fix reply credits its author and links the
+reviewed commit. A merged change is not necessarily in a published release;
+release availability and reporter confirmation remain separate facts. The
+development notes above are for local reproduction and validation, not an
+invitation to submit a pull request.
diff --git a/scripts/tests/test_contribution_report_safety.py b/scripts/tests/test_contribution_report_safety.py
index 00ea11512f..741803fb31 100644
--- a/scripts/tests/test_contribution_report_safety.py
+++ b/scripts/tests/test_contribution_report_safety.py
@@ -17,6 +17,57 @@ def report_guidance() -> str:
class ContributionReportSafetyTest(unittest.TestCase):
+ def contribution_surfaces(self):
+ return (
+ " ".join((ROOT / "CONTRIBUTING.md").read_text(encoding="utf-8").split()),
+ " ".join((ROOT / ".github/PULL_REQUEST_TEMPLATE.md").read_text(encoding="utf-8").split()),
+ )
+
+ def test_no_new_external_pr_submission_instructions(self):
+ guide, template = self.contribution_surfaces()
+ for text in (guide, template):
+ with self.subTest(surface=text[:40]):
+ self.assertIn("not accepting unsolicited external pull requests", text)
+ self.assertNotRegex(text, r"(?i)(?:^|[.!?]\s+|\d+\.\s+)Open a PR\b")
+ self.assertNotIn("Submitting Requested Changes", guide)
+ self.assertNotIn("Every requested PR", guide)
+
+ def test_patch_is_optional_evidence_in_existing_issue(self):
+ guide, template = self.contribution_surfaces()
+ self.assertIn("## Sharing a tested patch", guide)
+ self.assertIn("**existing issue**", guide)
+ self.assertIn("do not open a new pull request", guide)
+ self.assertIn("not a condition of reporting", guide)
+ self.assertIn("not a promise that the change will be used", guide)
+ self.assertIn("https://github.com/rcourtman/Pulse/blob/main/CONTRIBUTING.md#sharing-a-tested-patch", template)
+ self.assertIn("Do not duplicate an existing report", template)
+
+ def test_old_requested_contributions_keep_their_disposition(self):
+ guide, template = self.contribution_surfaces()
+ self.assertIn("one requested in an earlier conversation", guide)
+ self.assertIn("reply and a disposition in its own thread", guide)
+ self.assertIn("equivalent maintainer fix with credit and a commit link", guide)
+ self.assertIn("already requested in an earlier conversation", template)
+ self.assertIn("reply and disposition in this thread", template)
+ for text in (guide, template):
+ with self.subTest(surface=text[:40]):
+ self.assertNotIn("please close it and open an issue instead", text)
+ self.assertIn("refile", text)
+ self.assertIn("Do not recreate it or refile evidence", guide)
+ self.assertIn("do not recreate the PR or refile its evidence", template)
+
+ def test_code_evidence_preserves_safety_and_publication_limits(self):
+ guide, template = self.contribution_surfaces()
+ for statement in (
+ "source version", "tests actually run and known limits",
+ "do not repeat an unsafe failure", "production installation",
+ "public branch also exposes its commit history",
+ "[SECURITY.md](SECURITY.md)", "fix reply credits its author",
+ "release availability and reporter confirmation remain separate facts",
+ ):
+ self.assertIn(statement, guide)
+ self.assertIn("test does not establish release availability", template)
+
def test_collection_is_optional_and_distinct_from_downloading_a_result(self):
text = " ".join(report_guidance().split())
for statement in (