Skip to content

Commit

Permalink
Move issue templates to folder (#27)
Browse files Browse the repository at this point in the history
* Add issue templates folder

* Fix labels to be comma separated

as per https://help.github.com/en/github/building-a-strong-community/manually-creating-a-single-issue-template-for-your-repository

* update language

* Update the README and origami.json
  • Loading branch information
chee authored Mar 3, 2020
1 parent 427b3c9 commit 57af053
Show file tree
Hide file tree
Showing 5 changed files with 78 additions and 52 deletions.
37 changes: 0 additions & 37 deletions .github/ISSUE_TEMPLATE.md

This file was deleted.

36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/component-proposal.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
name: Component proposal
about: Propose a new component. Make sure you've checked the Origami Registry and the Components Backlog first!
labels: component, proposal
---
<!--
Check the Origami Registry and the Component Backlog for similar components:
Registry: https://registry.origami.ft.com/
Backlog: https://github.com/Financial-Times/origami-proposals/projects/1
If you need help putting your proposal together then please
contact the Origami team at origami.support@ft.com or
#origami-support on Slack.
-->


## What

> Give a brief description of the component you're proposing. Make it a short pitch so that we can quickly spot duplicate components.
>
> It's helpful in this section to suggest alternative names, e.g. a loading indicator could also be known as a "spinner".
## Why

> Explain why you think Origami should accept the proposal.
>
> E.g. When proposing a new component:
> - Do you have evidence that it's needed by multiple teams across the FT?
> - Do you have evidence that it meets the needs of the users of those teams?
## Supporting Examples

> Include links to examples, research, or code to support your proposal, if any is available.
>
> It's also useful to have links to designs if there are any.
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/pattern-proposal.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
name: Pattern proposal
about: Propose a new pattern which impacts multiple components.
labels: pattern, proposal
---
<!--
If you need help with putting your proposal together then please
contact the Origami team at origami.support@ft.com or
#origami-support on Slack.
-->


## What

> Give a brief description of the pattern you're proposing.
>
> Make it a short pitch so we can quickly spot previousy proposed patterns.
## Why

> Explain why you think Origami should accept the proposal.
>
> - What problem does the proposal aim to address?
> - Are there any known caveats to the proposal?
> - Which components would be affected by the proposal if it were accepted?
> - How would the proposal impact your workflow or that of other Origami users if it were accepted?
## Supporting Examples

> Include links to examples, research, or code to support your proposal, if any is available.
> It's also useful to have links to designs if there are any
20 changes: 8 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,22 @@
# Origami

# Origami Proposals

This repository is used to propose and track new [Origami] components, or patterns which impact multiple components.<br/>
For more information, please view the [Contributing Guide].
Welcome to Origami!

This is the repository where we track issues and proposals and discussions
related to the Origami team, components, services and everything else.

## Proposal Backlog

The **[Proposal Backlog]** is where you can track and edit proposals. We recommend checking here first before proposing a new component.


## Propose a new Component
### Propose a new Component

The **[Contributing Guide]** outlines how to create a new proposal, including how to propose a new component.


## Credit
### Credit

A lot of credit for this proposal process goes to the GOV.UK design system community, who maintain [a similar backlog here](https://github.com/alphagov/govuk-design-system-backlog).



[contributing guide]: https://github.com/Financial-Times/origami-proposals/blob/master/.github/CONTRIBUTING.md
[contributing guide]: https://github.com/Financial-Times/origami/blob/master/.github/CONTRIBUTING.md
[origami]: http://origami.ft.com/
[proposal backlog]: https://github.com/Financial-Times/origami-proposals/projects/1
[proposal backlog]: https://github.com/Financial-Times/origami/projects/1
6 changes: 3 additions & 3 deletions origami.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
{
"description": "Propose and track new Origami components",
"origamiType": null,
"description": "A repository for tracking the work of the Origami project",
"origamiType": "meta",
"origamiVersion": 1,
"keywords": [],
"support": "https://github.com/Financial-Times/origami-proposals/issues",
"support": "https://github.com/Financial-Times/origami/issues",
"supportStatus": "active",
"supportContact": {
"email": "origami.support@ft.com",
Expand Down

0 comments on commit 57af053

Please sign in to comment.