This checklist is meant to assist creators of PRs (to let them know what reviewers will typically look for) and reviewers (to guide them in a structured review process). Items do not need to be checked explicitly for a PR to be eligible for merging.
- The PR has a single goal that is clear from the PR title and/or description.
- All code changes represent a single set of modifications that logically belong together.
- No more than 500 lines of code are changed or there is no obvious way to split the PR into multiple PRs.
- The code can be understood easily.
- Newly introduced names for variables etc. are self-descriptive and consistent with existing naming conventions.
- There are no redundancies that can be removed by simple modularization/refactoring.
- There are no leftover debug statements or commented code sections.
- The code adheres to our conventions and style guide, and to the Julia guidelines.
- New functions and types are documented with a docstring or top-level comment.
- Relevant publications are referenced in docstrings (see example for formatting).
- Inline comments are used to document longer or unusual code sections.
- Comments describe intent ("why?") and not just functionality ("what?").
- If the PR introduces a significant change or new feature, it is documented in
NEWS.mdwith its PR number.
- The PR passes all tests.
- New or modified lines of code are covered by tests.
- New or modified tests run in less then 10 seconds.
- There are no type instabilities or memory allocations in performance-critical parts.
- If the PR intent is to improve performance, before/after time measurements are posted in the PR.
- The correctness of the code was verified using appropriate tests.
- If new equations/methods are added, a convergence test has been run and the results are posted in the PR.
Created with ❤️ by the Trixi.jl community.