diff --git a/.editorconfig b/.editorconfig index 84b955c018..0d5903a692 100644 --- a/.editorconfig +++ b/.editorconfig @@ -2,12 +2,16 @@ # ** DO NOT EDIT THIS FILE ** # *************************** # -# This file was generated by edx-lint: http://github.com/edx/edx-lint +# This file was generated by edx-lint: https://github.com/edx/edx-lint # # If you want to change this file, you have two choices, depending on whether # you want to make a local change that applies only to this repo, or whether # you want to make a central change that applies to all repos using edx-lint. # +# Note: If your pylintrc file is simply out-of-date relative to the latest +# pylintrc rules in edx-lint, ensure you have the latest edx-lint installed +# and then follow the steps for a "LOCAL CHANGE". +# # LOCAL CHANGE: # # 1. Edit the local .editorconfig_tweaks file to add changes just to this @@ -26,17 +30,28 @@ # 1. Edit the .editorconfig file in the edx-lint repo at # https://github.com/edx/edx-lint/blob/master/edx_lint/files/.editorconfig # -# 2. Make a new version of edx_lint, which involves the usual steps of -# incrementing the version number, submitting and reviewing a pull -# request, and updating the edx-lint version reference in this repo. +# 2. install the updated version of edx-lint (in edx-lint): # -# 3. Install the newer version of edx-lint. +# $ pip install . # -# 4. Run: +# 3. Run (in edx-lint): # +# # uses .editorconfig_tweaks from edx-lint for linting in edx-lint +# # NOTE: Use Python 3.x, which no longer includes comments in the output file # $ edx_lint write .editorconfig # -# 5. This will modify the local file. Submit a pull request to get it +# 4. Make a new version of edx_lint, submit and review a pull request with the +# .editorconfig update, and after merging, update the edx-lint version by +# creating a new tag in the repo (uses pbr). +# +# 5. In your local repo, install the newer version of edx-lint. +# +# 6. Run: +# +# # uses local .editorconfig_tweaks +# $ edx_lint write .editorconfig +# +# 7. This will modify the local file. Submit a pull request to get it # checked in so that others will benefit. # # @@ -52,6 +67,8 @@ # SERIOUSLY. # # ------------------------------ +# Generated by edx-lint version: 1.6 +# ------------------------------ [*] end_of_line = lf insert_final_newline = true @@ -77,7 +94,10 @@ trim_trailing_whitespace = false [.git/*] trim_trailing_whitespace = false +[COMMIT_EDITMSG] +max_line_length = 72 + [*.rst] max_line_length = 79 -# a699cc442902ab24adc720ac080c00e9ee72f728 +# f541be688d5bfddc4fdfc961a52e93edd05bc244