diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index 026fda5904..0000000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,37 +0,0 @@ - - - - -## What - -> Give a brief description of the component or pattern you wish to propose. This should be a short pitch so that we can quickly spot duplicate components, or previously proposed patterns. -> If proposing a new component, it's helpful in this section to also 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: -> - What evidence do you have that it's needed by multiple teams across the FT? -> - What evidence do you have that it meets the needs of the users of those teams? -> -> E.g. When proposing a pattern: -> - What problem does the proposal aim to address? -> - Are there any known caveats to the proposal? -> - Which components, if any, would be affected by the proposal if it were accepted? -> - How would the proposal, if accepted, impact your workflow or that of other Origami users? - - -## 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 diff --git a/.github/ISSUE_TEMPLATE/component-proposal.md b/.github/ISSUE_TEMPLATE/component-proposal.md new file mode 100644 index 0000000000..c5277bb73a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/component-proposal.md @@ -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 +--- + + + +## 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. diff --git a/.github/ISSUE_TEMPLATE/pattern-proposal.md b/.github/ISSUE_TEMPLATE/pattern-proposal.md new file mode 100644 index 0000000000..4ddae71e59 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/pattern-proposal.md @@ -0,0 +1,31 @@ +--- +name: Pattern proposal +about: Propose a new pattern which impacts multiple components. +labels: pattern, proposal +--- + + + +## 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 diff --git a/README.md b/README.md index 7652f17fa8..554ec5fc73 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,22 @@ +# Origami -# Origami Proposals - -This repository is used to propose and track new [Origami] components, or patterns which impact multiple components.
-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 diff --git a/origami.json b/origami.json index 9d515260b3..0312aae31f 100644 --- a/origami.json +++ b/origami.json @@ -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",