pull_request_template.md

parent	nav_order	title	layout
Decisions	1	Template	home

{short title of solved problem and solution}

Context and Problem Statement

{Describe the context and problem statement, e.g., in free form using two to three sentences or in the form of an illustrative story. You may want to articulate the problem in form of a question and add links to collaboration boards or issue management systems.}

Decision Drivers

• {decision driver 1, e.g., a force, facing concern, …}
• {decision driver 2, e.g., a force, facing concern, …}
• …

Considered Options

{title of option 1}

{example | description | pointer to more information | …}

• Good, because {argument a}
• Good, because {argument b}

• Neutral, because {argument c}
• Bad, because {argument d}
• …

{title of option 2}

{example | description | pointer to more information | …}

• Good, because {argument a}
• Good, because {argument b}
• Neutral, because {argument c}
• Bad, because {argument d}
• …

Decision Outcome

Chosen option: "{title of option 1}", because {justification. e.g., only option, which meets k.o. criterion decision driver | which resolves force {force} | … | comes out best (see below)}.

Implementation Plan

{List changes to be made in affected codes, as applicable, or list "N/A"}

• pymatgen: ...
• atomate2: ...
• emmet: ...
• crystal-toolkit: ...
• jobflow: ...
• maggma: ...

More Information

{You might want to provide additional evidence/confidence for the decision outcome here and/or document the team agreement on the decision and/or define when this decision when and how the decision should be realized and if/when it should be re-visited and/or how the decision is validated. Links to other decisions and resources might here appear as well.}