From 517b09bfe83b0784c9c7452ac9fb55067a091a14 Mon Sep 17 00:00:00 2001 From: alin m elena Date: Wed, 7 Aug 2024 12:29:05 +0100 Subject: [PATCH] reformat --- coding_style.md | 2 +- contributing.md | 13 ++++++++++++- 2 files changed, 13 insertions(+), 2 deletions(-) diff --git a/coding_style.md b/coding_style.md index da36434d..3b3f4351 100644 --- a/coding_style.md +++ b/coding_style.md @@ -1,4 +1,4 @@ # Coding style we adhere to pep8 https://peps.python.org/pep-0008/ and we automatically enforce it via pre-commit in the ci. -check your code manually before committing. \ No newline at end of file +check your code manually before committing. diff --git a/contributing.md b/contributing.md index 991ae94b..caf49f8d 100644 --- a/contributing.md +++ b/contributing.md @@ -48,6 +48,16 @@ The reviewer/s have the following responsibilities, - Only accepting a merge if all tests have passed - Using the comments system to request changes for the submittor to make +### Enforcing style + +github actions will automatically run precommit and enforce the style. +To reduce the number of failures in CI please run pre-commit locally before +you push to the repo + +```sh + pre-commit run --all-files +``` + ## Using the git for development The Github instance hosts an *upstream* repository, which we will refer to @@ -165,6 +175,7 @@ $ git rebase -i upstream/main $ git push ``` + ### Advanced git #### Keeping your fork in sync with project @@ -261,4 +272,4 @@ $ git push -d origin remoteBranch ## Code Coverage Ensure that any code you add does not reduce the code coverage in a meaningful way. Reviwers may insist on new test to be added, -please cooperate. \ No newline at end of file +please cooperate.