Skip to content

Commit

Permalink
feat: add pr template
Browse files Browse the repository at this point in the history
  • Loading branch information
zk-steve committed Aug 22, 2024
1 parent 1576f63 commit fe4cd5a
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 0 deletions.
22 changes: 22 additions & 0 deletions .github/auto_assign.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Set to true to add reviewers to pull requests
addReviewers: true

# Set to true to add assignees to pull requests
addAssignees: true

# A list of reviewers to be added to pull requests (GitHub user name)
reviewers:
- Draply
- 0x5ea000000
- hduoc2003
- zk-steve
- Tranduy1dol
- VanhGer

# A list of keywords to be skipped the process that add reviewers if pull requests include it
skipKeywords:
- wip

# A number of reviewers added to the pull request
# Set 0 to add all the reviewers (default: 0)
numberOfReviewers: 0
17 changes: 17 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Check List

- [ ] Don't forget to squash commits into meaningful chunks before merging
- [ ] Check every test passed.
- [ ] Did you split imports into std and custom parts?
- [ ] Have you updated the consts in ORN?
- [ ] Have you run ORN with the latest version?
- [ ] Check your commit messages.
- [ ] Have you added meaningful comments?
- [ ] Don't forget to optimize gas cost!
- [ ] Calling vector::length() multiple times is expensive (e.g. in loops), save it to a variable instead.
- [ ] Consider using consts for things that can be pre-computed.
- [ ] `pow(2, x) => (1 << x+1)`
- [ ] `inline` short functions to save gas.
- [ ] Find all vector::empty() in all files and replace them with the first append
- [ ] Use vector::\*\_reverse\_\*() version to save gas.
- [ ] Check Visibility of functions

0 comments on commit fe4cd5a

Please sign in to comment.