search

global-aws-community / aws-ug-cookbook

A collaborative resource for AWS user groups worldwide to share best practices, tips, and strategies for organizing successful community events.
MIT License
6 stars 4 forks source link

Create templates/typification for issue to make contributions easier #14

Open diego7marques opened 1 day ago

diego7marques commented 1 day ago

We should create templates for issues. It helps users to write more complete and robust issues/feature requests providing a set of questions as starting point.

Doc Ref: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository

Example from KEDA repo:

image

diego7marques commented 1 day ago

@tigpt, I've created the PR #15 to address this topic. I tried to adapt the naming conventions from the example to something more related to our scenario, for example, from feature request to content request. Let me know what you think about that.

I did two categories to start:

The configuration also allows blank issues in case none of the template fits.

As soon as you approve the PR, the templates will be available to everyone who try to create a new issue.

🚨🚨 Before approving the PR, you should create the labels: needs-discussion, feature-request and bug. 🚨🚨 (sorry for the extra work 😅 )