From f6ef6ecbd99cd8dc811d5fe87273367b8b87c9c1 Mon Sep 17 00:00:00 2001 From: Lewis Date: Thu, 21 May 2026 22:46:01 +0300 Subject: [PATCH] feat(docs): first version of 'when PRing' section of contrib Lewis: May this revision serve well! --- CONTRIBUTING.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8e5dd75..d908533 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,21 @@ # Contributing to Tranquil PDS +## When PRing + +In order of importance: + +- **You must run your change! Every contribution that says "here's xyz. untested." does not help the project.** +- Relevant tests to your PR must pass. The whole suite doesn't have to be proven to have run, because there are a *ton* of tests and they're quite heavy, but hopefully there are existing tests for whatever you're PRing, and if there aren't, please add those too. +- Run cargo fmt :P + +> 🦪 Lewis +> +> Good CI fixes some of these. We should really get around to that. + +Things that would also be nice but aren't like, a pain in our side: + +- Big changes should be stacked PRs that are broken up into digestible pieces. Those stacked PRs should hopefully be able to be merged individually if necessary. + ## Local Development ### Prerequisites