-
-
Notifications
You must be signed in to change notification settings - Fork 823
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
3 changed files
with
31 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,8 @@ | ||
template_chooser: | ||
enabled: true | ||
default: "other.md" | ||
choices: | ||
- name: "New Helper" | ||
file: "new_helper.md" | ||
- name: "Other Changes" | ||
file: "other.md" |
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,23 @@ | ||
|
||
## Describe your changes | ||
|
||
... | ||
|
||
## Checklist before requesting a review | ||
|
||
- [ ] 👓 I have performed a self-review of my code | ||
- [ ] 👶 This helper does not already exist | ||
- [ ] 🧪 This helper is tested | ||
- [ ] 🏎️ My code limits memory allocation and is fast | ||
- [ ] 🧞♂️ This helper is immutable and my tests prove it | ||
- [ ] ✍️ I implemented the parallel and mutable variants | ||
- [ ] 📖 My helper has been added to README | ||
- [ ] 🔬 An example has been added to xxxxx_example_test.go | ||
- [ ] ⛹️ An example has been created on https://go.dev/play | ||
|
||
## Conventions | ||
|
||
- Returning `(ok bool)` is often better than `(err error)` | ||
- `panic(...)` must be limited | ||
- Helpers should allow batching (eg: receive variadic arguments) | ||
- Use an index at the end of the helper name to declare variants (eg: `lo.Must0`, `lo.Must1`, `lo.Must2`...) |
Empty file.