-
Notifications
You must be signed in to change notification settings - Fork 567
PR Creation & Approval Guidelines for Tpetra, Ifpack2, and MueLu Developers
A minimal PR description should include the following:
Issue: #XXX
Tests: YYYY
Stakeholder Feedback: ZZZ
If you're a code reviewer, be sure to either add that information or get the PR author to do so.
Make sure there's a Trilinos Issue associated with your PR. Ideally, this will explain what the PR is supposed to do. Link to the issue in the PR description on the "issue" line.
What did you do to convince yourself the code is correct? If you added a new test, note that. If you fixed a test that is somehow erroneous, note that too. If the change is a "back end" sort of change that the testing system shouldn't notice then "all tests pass" is probably fine. New capabilities should almost always have an accompanying test. (Experimental code may be an exception.) "Untested code is by definition broken" -- Anonymous.
If this PR is in response to a stakeholder request, note that. Something like "Discussed with George Washington via email" would be fine. For requests that aren't stakeholder-driven, e.g., you're fixing the nightly tests because an OS upgrade broke them, "n/a" is fine.
Copyright © Trilinos a Series of LF Projects, LLC
For web site terms of use, trademark policy and other project policies please see https://lfprojects.org.
Trilinos Developer Home
Trilinos Package Owners
Policies
New Developers
Trilinos PR/CR
Productivity++
Support Policy
Test Dashboard Policy
Testing Policy
Managing Issues
New Issue Quick Ref
Handling Stale Issues and Pull Requests
Release Notes
Software Quality Plan
Proposing a New Package
Guidance on Copyrights and Licenses
Tools
CMake
Doxygen
git
GitHub Notifications
Mail lists
Clang-format
Version Control
Initial git setup
'feature'/'develop'/'master' (cheatsheet)
Simple centralized workflow
Building
SEMS Dev Env
Mac OS X
ATDM Platforms
Containers
Development Tips
Automated Workflows
Testing
Test Harness
Pull Request Testing
Submitting a Pull Request
Pull Request Workflow
Reproducing PR Errors
Addressing Test Failures
Trilinos Status Table Archive
Pre-push (Checkin) Testing
Remote pull/test/push
PR Creation & Approval Guidelines for Tpetra, Ifpack2, and MueLu Developers