-
Notifications
You must be signed in to change notification settings - Fork 132
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
1 parent
9bd30cb
commit 40b8da9
Showing
1 changed file
with
37 additions
and
0 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 |
---|---|---|
@@ -0,0 +1,37 @@ | ||
## Code of Conduct | ||
|
||
* Be kind to others ; | ||
* Critic code not people. | ||
|
||
## Code Conventions for `pure` | ||
|
||
### Public item | ||
|
||
> Namespace your item with the prefix `pure_`. | ||
* variable: `pure_my_variable` | ||
* function: `pure_my_public_function` | ||
* filename: `pure_my_public_file.fish` | ||
* test file: `pure_my_public_file.test.fish` | ||
|
||
### Private item | ||
|
||
> Namespace your item with the prefix `_pure_` (begin with a single underscore). | ||
* variable: `_pure_my_variable` | ||
* function: `_pure_my_private_function` | ||
* filename: `_pure_my_private_file.fish` | ||
* test file: `_pure_my_private_file.test.fish` | ||
|
||
### Local and Tools | ||
|
||
> No need to use namespace when your variable variable is declare locally (`set --local`) or your file/test file is related to tooling (_installer.fish_, testing package managers install). | ||
* filename: `my_tool.fish` | ||
* test file: `my_tool.test.fish` | ||
|
||
--- | ||
|
||
We will update if other cases arise. | ||
|
||
If you are in favor of adding a `CONTRIBUTING.md`, upvote #100. |