search

govuk-one-login / tech-docs

Documentation for integrating with GOV.UK One Login
https://docs.sign-in.service.gov.uk/
MIT License
8 stars 3 forks source link

Create a default issue template to structure information gathered #175

Closed pauldougan closed 7 months ago

pauldougan commented 9 months ago

At the moment new issues have no structure and are free format.

We should add a simple template to help structure the issues so that we are able to understand user needs.

There must be some good examples elsewhere in use at GDS we can look at for inspiration

pauldougan commented 9 months ago

the design system has a number of templates for their issues https://github.com/alphagov/govuk-design-system/issues/new/choose

huwd commented 9 months ago

Likely a good idea to cross reference it with our PR template too? What checks do we want people to have done by PR stage that they could begin exploring at issue? https://github.com/govuk-one-login/authentication-tech-docs/blob/main/.github/pull_request_template.md

pauldougan commented 9 months ago

we need to bear in mind the the users of this issue template are not GDS insiders but people in other government departments and their delivery partners who are using the technical documentation to build integrations.

pauldougan commented 8 months ago

@jankishah-gds any chance you can add the issue template you are working on from the DI team manual? https://github.com/govuk-one-login/team-manual/pull/505 we need this for the One Login Tech docs. Thanks

pauldougan commented 7 months ago

closing this issue and moving it to JIRA AP-181