Nulo/fzf.kak
1
0
Fork 0
Code Releases Activity

Update CONTRIBUTING.md

Browse source
This commit is contained in:
Andrey Orst 2018-09-24 14:43:35 +03:00 committed by GitHub
parent cd69b56bab
commit 6666d61450
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
CONTRIBUTING.md
View file

@ -36,7 +36,11 @@ Bad code:
def fzf-good-exmpl %{ fzf "echo $1" "echo 'actually I''m bad example' | tr ' ' '\n'" } def fzf-good-exmpl %{ fzf "echo $1" "echo 'actually I''m bad example' | tr ' ' '\n'" }
``` ```
Although such code is short, it is not *safe*, because reloading kakrc will cause an error here. Although such code is short, the main idea of programming language is being a language, and speak
with the one who writes the code later. This may not be the best example of code that was made short
by sacrificing readability, but can give you an idea what kind of code is welcomed in this project,
and what isn't. "Write-only" code should be avoided in projects of any size and any task.
Also user doesn't know about all fzf commands, and by not adding command to `fzf-mode` you force Also user doesn't know about all fzf commands, and by not adding command to `fzf-mode` you force
user to search for fzf commands in command-line which isn't the way how plugin should work. And even user to search for fzf commands in command-line which isn't the way how plugin should work. And even
if user finds this command in command-line, there's no documentation, and name is short and may be not if user finds this command in command-line, there's no documentation, and name is short and may be not