XorA
/
bash-it
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #1728 from Bash-it/NoahGorny-patch-1 

Update contribution.rst
pull/1708/head
Noah Gorny 2020-12-07 09:32:52 +02:00 committed by GitHub
parent 18365035a9 7dcf4dd186
commit 9904857132
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/contributing.rst
View File

@ -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. * When adding new files, be sure to add them into `clean_files.txt`, which is a growing list of linted files in the project.
* 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 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 <http://EditorConfig.org>`_\ , the editor should automatically use the settings defined in Bash-it's `.editorconfig file <.editorconfig>`_. 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``. * 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``. Don't use underscores, e.g. ``my_new_function``.