-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
12 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,13 @@ | ||
# # Code principles | ||
|
||
|
||
# Here we will write about principles which we developed through our publication. | ||
# Here we will write about principles which we developed through our [publication](https://apertureneuro.org/article/116386-the-art-of-brainwaves-a-survey-on-event-related-potential-visualization-practices): | ||
|
||
# - Code should be clear and concise. | ||
# - Variables inside the code should have meaningful names. | ||
# - Every function exposed to the user should have documentation that specifies all parameters, types, input and output arguments. | ||
# - Most people will not look at the defaults, so it is very important to nudge users to label important details of the plot. | ||
# - Variables in the code should have meaningful names. | ||
# - Every function exposed to the user should have documentation that specifies all parameters, types, and input and output arguments. | ||
# - Most people will not look at the defaults, so it is very important to encourage users to label important details of the representation. | ||
# - Function naming should be based on some theory and naming conventions. | ||
# - You should avoid functions longer 50 lines. | ||
# - You should avoid functions longer than 50 lines. | ||
# - You should avoid putting more than 5 functions in a file. | ||
# - You should avoid pull requests with more than 10 affected files. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters