Please remove everything except for the template best matching your issue type below. Then ensure you fill in the template, to the best of your abilities before submitting.
TerraFX and everyone contributing (this includes issues, pull requests, the wiki, etc) must abide by the CODE_OF_CONDUCT. Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at admin@terrafx.dev.
Questions are straightforward, just prefix your issue title with [QUESTION]
and state what you desire to be answered.
Bugs need to be both reproducible or we need some other mechanism of being able
to debug and determine the root cause of failure. Please prefix your issue title
with [BUG] and fill out the following sections.
This section should contain an expanded description of the bug, if the title is not sufficient.
This section should contain an ordered list of steps that can be used to reproduce the bug. Ideally, you would include as much information about your environment as possible to help use in determining the best fix for the issue.
This section should contain a description of the behavior that is expected.
This section should contain a description of the actual behavior being observed.
Regressions are similar to bugs but represent functionality that worked in a
prior release but is no longer functioning as expected. Please prefix your issue
title with [REGRESSION] and fill out the same sections as for a Bug.
Requests would ideally always be well thought and come with a full proposal;
however, this is not always possible and sometimes you want input from others
before actually proposing something. Please prefix your issue title with
[IDEA] and give a brief summary of what you want.
Proposals are generally thought out and discussed ideas that are ready to be
proposed for inclusion in the project. Please prefix your issue title with
[PROPOSAL] and fill out the following sections.
This section should contain an expanded description of the proposal, if the title is not sufficient.
This section should contain the reasoning behind the proposal. It should include things like "Why do we need this", "How will it improve a developers quality of life", etc.
This section should contain the APIs being proposed along with a brief description of what each API does.
This should contain any drawbacks for the proposal that came up during the discussions.
This should contain any alternative proposals that came up during the discussions.
This should contain any additional thoughts or footnotes on the proposal.
This section should contain a link to all discussions related to the proposal that have been made thus far.