docs: Add lint_clean_files instructions

This commit is contained in:
Noah Gorny
2020-12-16 20:01:46 +02:00
parent 9ca6841e20
commit 8bc83b2d48
2 changed files with 19 additions and 1 deletions

View File

@@ -39,7 +39,7 @@ Code Style
* When adding new files, be sure to add them into `clean_files.txt`, which is a growing list of linted files in the project.
* When changing existing files, consider also adding them into `clean_files.txt` and fixing the linting errors that arise.
* When changing existing files, consider also adding them into `clean_files.txt` and fixing the linting errors that arise. See :ref:`linting_your_changes` for more information.
* Indentation is using tabs, not spaces. Most of the code is indented with 2 spaces, some with 4 spaced tabs. Please try to stick to tabs.
If you're using an editor that supports `EditorConfig <http://EditorConfig.org>`_\ , the editor should automatically use the settings defined in Bash-it's `.editorconfig file <.editorconfig>`_.
* When creating new functions, please use a dash ("-") to separate the words of the function's name, e.g. ``my-new-function``.