From 11d1df4e01cb22955755ca5d1cec227f189ebb95 Mon Sep 17 00:00:00 2001 From: Joshua Gawley <16921823+joshuagawley@users.noreply.github.com> Date: Fri, 30 Dec 2022 19:35:25 +0000 Subject: [PATCH] Update CONTRIBUTING.md (#1887) * Update CONTRIBUTING.md * Update CONTRIBUTING.md with Clippy information * Update commands in CONTRIBUTING.md --- CONTRIBUTING.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 447f51bd..59f4b5f9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -22,6 +22,8 @@ If you encounter a bug when using Lapce, check the issues to see if anyone else If you want to write some code, develop the documentation, or otherwise work on a certain feature or bug, let us know by replying to or creating an [issue](https://github.com/lapce/lapce/issues). +Run `cargo fmt --all` and `cargo clippy` on your code before submitting pull requests and fix any issues; this makes sure that the CI runs only fail on genuine build errors and not formatting/Clippy lints. + We are currently in the process of improving the documentation for new developers/code contributors. Feel free to get started, or post a message on [Discord](https://discord.gg/n8tGJ6Rn6D) to see what can be done. ## Contact