Skip to content

Commit

Permalink
chore: adding issue template
Browse files Browse the repository at this point in the history
  • Loading branch information
samber committed Jun 30, 2024
1 parent 52e17fa commit aa442e5
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 0 deletions.
8 changes: 8 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/config.yml
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"
23 changes: 23 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/new_helper.md
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.

0 comments on commit aa442e5

Please sign in to comment.