From 656b24b701e8df5f707927785f3bd4231f6b180e Mon Sep 17 00:00:00 2001 From: Andrew Pareles <43356051+andrewpareles@users.noreply.github.com> Date: Mon, 30 Sep 2024 01:39:42 -0700 Subject: [PATCH] Add PR guidelines to CONTRIBUTING.md --- CONTRIBUTING.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 685812b6..982c6af6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -124,7 +124,14 @@ Please don't make big refactors without speaking with us first. We'd like to kee # Submitting a Pull Request -When you've made changes and want to submit them, please submit a pull request. +When you've made changes and want to submit them, please submit a pull request. Here are a few guidelines: + +- A PR should be about one *single* feature change. Break large changes into multiple PRs. +- Your title should clearly describe the change you made. +- Your description should cover the exact files and changes you made. Please don't use vague statements like "refactored code" or "improved types" (instead, describe what code you refactored, or what types you changed). +- Add tags to help us stay organized! +- Please don't open a new issue for your PR. + # Relevant files