Skip to content

Commit

Permalink
README/editorconfig: Add .editorconfig to improve editing consistency.
Browse files Browse the repository at this point in the history
Add small section in README to document the benefits.
  • Loading branch information
neiljp committed Apr 27, 2023
1 parent 10e02d0 commit db866cb
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 0 deletions.
26 changes: 26 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# See https://editorconfig.org

root = true

[*]
end_of_line = lf
charset = utf-8
indent_size = 4
indent_style = space
trim_trailing_whitespace = true
insert_final_newline = true

[*.{py,pyi}]
max_line_length = 88

[*.{md,yaml,yml}]
indent_size = 2

[Makefile]
indent_style = tab

[*.diff]
trim_trailing_whitespace = false

[.git/*]
trim_trailing_whitespace = false
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -494,6 +494,15 @@ If using make with pip, running `make` will ensure the development environment
is up to date with the specified dependencies, useful after fetching from git
and rebasing.

#### Editing the source

Pick your favorite text editor or development environment!

The source includes an `.editorconfig` file which enables many editors to
automatically configure themselves to produce files which meet the minimum
requirements for the project. See https://editorconfig.org for editor support;
note that some may require plugins if you wish to use this feature.

#### Passing linters and automated tests

The linters and automated tests (pytest) are run in CI (GitHub Actions) when
Expand Down

0 comments on commit db866cb

Please sign in to comment.