Skip to content

Commit

Permalink
Create pull_request_template.md
Browse files Browse the repository at this point in the history
Add a template for code review process. It will be included in the upcoming pull requests on this branch.
  • Loading branch information
dimalvovs authored Feb 21, 2024
1 parent d548222 commit 0662fce
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions .github/workflows/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
This is a code review template, it will be displayed after each pull request.
We do code reviews because we care about quality of our codebase and because we care about long-term development goals.
We do not do code reviews to blame the ones who contribute. There is no seniority in this process and there is no perfect code,
we just want to avoid storing code that is not OK.

## For the submitter

- [ ] `R CMD build` & `R CMD check` pass
- [ ] Needed tests exist and passing or not needed
- [ ] The change is sufficiently small

## For the reviewer

- [ ] OK, code does what it's intended for
- [ ] its' OK to do it that way
- [ ] it's OK to read and comprehend the code
- [ ] tests, documentation, style are OK

0 comments on commit 0662fce

Please sign in to comment.