search

CircleCI-Public / azure-cli-orb

CircleCI orb to install and configure the Azure CLI
https://circleci.com/orbs/registry/orb/circleci/azure-cli
MIT License
2 stars 13 forks source link

Update to use recommended issue template #4

Closed gep13 closed 5 years ago

gep13 commented 5 years ago

Checklist

Motivation, issues

When viewing the current issue template on GitHub, you are presented with this information:

image

The documentation for this GitHub feature can be found here:

https://help.github.com/en/articles/about-issue-and-pull-request-templates

On reading that article, the recommendation is to switch to the new issue template format:

It is possible to manually create a single issue template in Markdown using the legacy issue template workflow, and project contributors will automatically see the template's contents in the issue body. However, we recommend using the upgraded multiple issue template builder to create issue templates.

Description

Remove the existing ISSUE_TEMPLATE.md file, and replace it with a new bug.md file in the ISSUE_TEMPLATE folder.

This opens up the potential for creating multiple issue templates, for example, one specifically for requesting a new feature, reporting a security finding, etc.

Related Pull Requests

I have opened similar PR's in other Orb Repositories:

https://github.com/CircleCI-Public/twilio-orb/pull/3 https://github.com/CircleCI-Public/slack-orb/pull/88 https://github.com/CircleCI-Public/docker-orb/pull/23 https://github.com/CircleCI-Public/circleci-cli-orb/pull/2 https://github.com/CircleCI-Public/build-tools-orb/pull/15 https://github.com/CircleCI-Public/artifactory-orb/pull/17

lokst commented 5 years ago

Thank you @gep13. Closing this as it overlaps with https://github.com/CircleCI-Public/azure-cli-orb/pull/5.