-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Move issue templates to folder (#27)
* 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
Showing
5 changed files
with
78 additions
and
52 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters