Skip to content

Issue Templates

Darrin Fong edited this page Jan 26, 2020 · 3 revisions

ABOUT

Copy paste the following template when creating an enhancement/bug fix issue.

Template for feature implementation issue

## Purpose
<!--- A clear and concise description of the proposed new feature. -->

## Context
<!-- Why the new feature would be useful -->

## Possible Implementation (optional)
<!--- Not obligatory, but suggest an idea for implementing the new feature-->

## Related issues (optional)
<!-- Link any related issue-->

## Acceptance tests
<!-- Which criterion have to be met for the stakeholder to consider this as done --> 

Template for creating a bug report issue

<!--- Provide a general summary of the issue in the title above -->

## Expected Behavior
<!--- Tell us what should happen. Add an example with all 
 the information needed to reproduce the bug (descriptors, inputs, etc) -->

## Current Behavior
<!--- Tell us what happens instead of the expected behavior. Add an example with all 
 the information needed to reproduce the bug (descriptors, inputs, etc) -->

## Environment (optional)
<!--- Information about the execution environment, in particular: Python version, Docker/Singularity version
 if relevant -->

## Context (optional)
<!--- How has this issue affected you? What are you trying to accomplish? -->
<!--- Providing context helps us come up with a solution that is most useful in the real world -->

## Possible fix (optional)
<!--- Not obligatory, but suggest an idea to fix the prroblem -->

## Related issues (optional)
<!--- Link any related issue -->

Clone this wiki locally