-
Notifications
You must be signed in to change notification settings - Fork 2
Issue Templates
By using these templates, users can streamline the process of creating structured and informative issue reports, facilitating effective communication between users and project maintainers.
Issue templates are pre-defined structures that help standardize the information included in issue reports. They serve as a guide for users to provide consistent and relevant details when reporting an issue, making it easier for developers and maintainers to understand, reproduce, and resolve the problem efficiently.
By following a specific template, users can ensure that essential information is included in their issue reports, such as a clear description of the problem, steps to reproduce it, and any additional context or examples that may be relevant. This consistency in reporting enhances communication between users and project maintainers, enabling faster issue resolution and a better overall user experience.
To create an issue based on a specific template, follow these steps:
- Access the repository's "Issues" section.
- Click on the "Get started with an issue template" drop-down menu.
- Choose the appropriate template from the list that appears.
- The template's content will populate the issue description area.
- Fill in the required information and complete the template with the relevant details for your issue.
- Add any additional information, context, or examples that can help the maintainer understand the problem better.
- Once you have completed the template, click on the "Submit new issue" button to create the issue.
The following issue templates are available in this project:
Use this template to propose or discuss a new policy.
Use this template if you have identified an issue that is a duplicate of an existing one.
Use this template to report an issue related to a policy that needs fixing.
Use this template to report an issue related to Terraform configuration.
Use this template to report an issue related to tests or test cases.
Use this template to report a security vulnerability in the project.
Use this template to submit a feature request for the project.
ℹ️ Note: Please refer to the specific template that aligns with your issue or request and follow the instructions provided to include all relevant details. By utilizing these templates, you can ensure that your issues are properly documented and increase the chances of timely resolution.