Skip to content

Latest commit

 

History

History
45 lines (23 loc) · 2.99 KB

ISSUES.md

File metadata and controls

45 lines (23 loc) · 2.99 KB
Raw

Issue Reporting and Lifecycle

Issue Reporting Checklists

We welcome your feature requests and bug reports. Below you'll find short checklists with guidelines for well-formed issues of each type.

Bug Reports

  • Test Against the Latest Release:

    Make sure you test against the latest released version. It's possible we already fixed the bug you're experiencing.

  • Search for Possible Duplicate Issues:

    It's helpful to keep issues consolidated to one thread, so do a quick search on existing issues to check if anybody else has reported the same thing. You can scope searches by the label "bug" to help narrow your search.

  • Include the Steps to Reproduce:

    Provide steps to reproduce the issue, along with your .tf files. Without this information, it makes it much harder to diagnose and resolve the issue. Please ensure all secrets and identifiable information is removed.

  • For Panics, Include the crash.log:

    If you experienced a panic, please create a gist of the entire generated crash log. Review the log to ensure no sensitive or identifiable information is included.

Enhancement and Feature Requests

  • Search for Possible Duplicate Requests:

    It's helpful to keep requests consolidated to one thread. so do a quick search on existing issues to check if anybody else has reported the same thing. You can scope searches by the label "enhancement" to help narrow your search.

  • Include a Use Case Description:

    In addition to describing the behavior of the feature you'd like to see added, it's helpful to also describe the reason why the enhancement or feature would be important and how it would benefit the provider users.

Issue Lifecycle

  1. The issue is reported on GitHub.

  2. The issue is acknowledged and categorized by a provider collaborator. Categorization is done via GitHub labels. We use one of bug, enhancement, feature, documentation, or question.

  3. An initial triage process determines whether the issue is critical and must be addressed immediately, or can be left open for community discussion. In this step, we typically assign a size estimate to the work involved for that issue for our reference.

  4. The issue is then queued in our backlog to be addressed in a pull request or commit. The issue number will be referenced in the commit message and pull request so that the code that fixes it is clearly linked.

  5. The issue is closed. Sometimes, valid issues will be closed because they are tracked elsewhere or non-actionable. The issue is still indexed and available for future viewers or can be re-opened, if necessary.