Skip to content

Commit

Permalink
reformat
Browse files Browse the repository at this point in the history
  • Loading branch information
alinelena committed Aug 7, 2024
1 parent d002d1d commit 517b09b
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 2 deletions.
2 changes: 1 addition & 1 deletion coding_style.md
Original file line number Diff line number Diff line change
@@ -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.
check your code manually before committing.
13 changes: 12 additions & 1 deletion contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -165,6 +175,7 @@ $ git rebase -i upstream/main
$ git push
```


### Advanced git

#### Keeping your fork in sync with project
Expand Down Expand Up @@ -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.
please cooperate.

0 comments on commit 517b09b

Please sign in to comment.