Skip to content

Commit

Permalink
a new PR template
Browse files Browse the repository at this point in the history
closes #110
  • Loading branch information
exaexa committed Jul 28, 2021
1 parent 543971c commit 20bd283
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,17 @@
# Description of the proposed change

*Please include a short description of enhancement here*
## Description

> Describe functionality that the PR adds, changes or removes; optionally link
> issues that are closed by the PR.
#### Checklist

> Feel free to open PRs that do not satisfy the whole checklist. On the other
> hand, all these are required for merging.
- [ ] All code is formatted with
[JuliaFormatter](https://github.com/domluna/JuliaFormatter.jl)
(run `using JuliaFormatter; format("path/to/COBREXA.jl");`)
- [ ] Tests work (try with `]test COBREXA`)
- [ ] All new functions have proper docstrings
- [ ] Documentation builds correctly (try with `cd docs; julia make.jl`)

0 comments on commit 20bd283

Please sign in to comment.