Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions .github/ISSUE_TEMPLATE/component_change_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
name: Component Change Request
about: If you would like to add or modify a component in Protocol, use this template
title: "Component Change Request"
labels: "Component Change Request"
assignees: ''
---

Please use this template to request changes to an existing component.

If you're not sure whether a component already exists,
probably better to just file a new component request and let the Protocol Team triage.

Fill in as many sections as possible below.

### Please describe the use case(s) for this component

What does the component do? In what contexts is it used. Be as specific as possible.

### Please describe the change you wish to see

What's changing?

### Please describe why these changes need to be made

And why

### Please provide any designs or prototypes of the proposed changes

Add screenshots, mockups, code prototypes, etc. in this section.

### Please describe where this component is currently in use

In order to assess the risk of changes, we need to know where components exist in the wild.

### Please describe what this component should do in the following conditions

* When set in front of a dark background
* When set in front of a light background
* When viewed in a mobile/responsive viewport

### Is the development of this component a blocking dependency for other work? Please explain if so

Generally speaking, component definition should happen after a singleton instance has been developed,
or if the Protocol team has come to a consensus on need. If this is a rush job/or blocking dependency
please describe why this is needed.


39 changes: 39 additions & 0 deletions .github/ISSUE_TEMPLATE/new_component_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
name: New Component Request
about: If you would like to add or modify a component in Protocol, use this template
title: "New Component Request"
labels: "New Component Request"
assignees: ''
---

Please use this template to request a new component.
If you're not sure whether a component already exists,
go ahead and file the issue here, and the team will triage appropriately.

Fill in as many sections as possible below.

### Please describe the use case(s) for this component

What does the component do? In what contexts is it used. Be as specific as possible.

### Please provide any designs or previous implementations of the proposed component

Add screenshots, mockups, code prototypes, etc. in this section.

## Please describe what this component does in the following conditions

* When set in front of a dark background
* When set in front of a light background
* When viewed in a mobile/responsive viewport

### Please provide examples of this type of component in use in non-Mozilla web properties

Add screenshots and links to web properties that use a similar component.
(We ask for this because we want to make sure we are following industry conventions while building components)

### Is the development of this component a blocking dependency for other work? Please explain if so

Generally speaking component definition should happen after a singleton instance has been developed,
or if the Protocol team has come to a consensus on need.


1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
## HEAD

* **docs:** Added component issue templates (#379)
* **css:** Bold menu titles (#481)
* **css:** Add Menu List component (#474)
* **css:** Fx theme CTAs should use the Metropolis Font (#468)
Expand Down
7 changes: 7 additions & 0 deletions src/pages/docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,13 @@ minor tweaks that don’t need extensive testing or review, but for any serious
coding you really should have a local instance running so you can see your work
as it progresses.

### Requesting New or Updated Components

If you would like to request changes to a component or a new component be added to Protocol,
please [submit an issue on Github](https://github.com/mozilla/protocol/issues) using the appropriate
issue template. Please make sure to fill out this template as thoroughly as possible,
as this will help the team triage effectively.

### Reporting Bugs

To report an error you’ve discovered in Protocol, [submit an issue on Github](https://github.com/mozilla/protocol/issues)
Expand Down