From 7dcf4dd186f58e6b2d1e2090dd3a0c762911e134 Mon Sep 17 00:00:00 2001 From: Noah Gorny Date: Sun, 6 Dec 2020 23:02:16 +0200 Subject: [PATCH] Update contribution.rst Now includes relevant change about `clean_files.txt` and improves the part about our coding style --- docs/contributing.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/contributing.rst b/docs/contributing.rst index e2c3f5ca..9964e03c 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -38,8 +38,9 @@ Code Style ---------- -* Try to stick to the existing code style. Please don't reformat or change the syntax of existing code simply because you don't like that style. -* Indentation is using spaces, not tabs. Most of the code is indented with 2 spaces, some with 4 spaces. Please try to stick to 2 spaces. +* 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. +* 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 `_\ , 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``. Don't use underscores, e.g. ``my_new_function``.