From c2fbd0ccb0c1611514a824e4b26fb8884d6b78f8 Mon Sep 17 00:00:00 2001 From: erexer <13180883+erexer@users.noreply.github.com> Date: Tue, 12 Nov 2024 11:16:56 -0800 Subject: [PATCH] docs instructions for development/contributing --- CONTRIBUTING.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 19fca8a..799ed2f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -13,11 +13,13 @@ __I found a bug!__ __I fixed a bug!__ * First of all, thanks! +* Make sure that you're running the changed files and/or new files through pre-commit by running `$ pip install pre-commit` and `$ pre-commit install` in the mosartwmpy repo. Pre-commit will now automatically check your file formatting when you `$ git commit`. * Open a [new Pull Request] with the fix. Ensure the description clearly outlines the bug and the solution. Include the Issue number if applicable. __I created a new feature!__ * You're the best! * Consider opening a [new Issue] to describe use cases for the new feature. This will offer a platform for discussion and critique. +* Make sure that you're running the changed files and/or new files through pre-commit by running `$ pip install pre-commit` and `$ pre-commit install` in the mosartwmpy repo. Pre-commit will now automatically check your file formatting when you `$ git commit`. * Then, open a [new Pull Request] with clear documentation of the methodology. Be sure to include new unit tests if appropriate. -The [IM3] team truly appreciates and encourages community involvement. We're all in this together! \ No newline at end of file +The [IM3] team truly appreciates and encourages community involvement. We're all in this together!