Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
bobzhang authored Jun 24, 2024
1 parent f6ce377 commit 49f3103
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@ After submitting your pull request, request a review from the project maintainer

# Naming conventions

- function names, `snake_case` is preferred
- type paramaters, one character starting from `A` is preferred, e.g, `fn map[A,B](self : Array[A], f : (A) -> (B)) -> Array[B]`
- type names, `CamlCase` is preferred, if one package is centered around one specific type, short name `T` is preferred, e.g, `@sorted_set.T`
- function names, `snake_case` is preferred.
- type paramaters, one character starting from `A` is preferred, e.g, `fn map[A,B](self : Array[A], f : (A) -> (B)) -> Array[B]`, for some established
conventions, `Map[K,V]` it is also accepted.
- type names, `CamlCase` is preferred, if one package is centered around one specific type, short name `T` is preferred, e.g, `@sorted_set.T`.

0 comments on commit 49f3103

Please sign in to comment.