From d6ac7427e9d4638758e81e27dc66f06d9bfdd7e1 Mon Sep 17 00:00:00 2001 From: johngruen Date: Fri, 13 Sep 2019 18:36:16 +0200 Subject: [PATCH] add component issue templates --- .../component_change_request.md | 48 +++++++++++++++++++ .../ISSUE_TEMPLATE/new_component_request.md | 39 +++++++++++++++ CHANGELOG.md | 1 + src/pages/docs/contributing.md | 7 +++ 4 files changed, 95 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/component_change_request.md create mode 100644 .github/ISSUE_TEMPLATE/new_component_request.md diff --git a/.github/ISSUE_TEMPLATE/component_change_request.md b/.github/ISSUE_TEMPLATE/component_change_request.md new file mode 100644 index 000000000..2ace30100 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/component_change_request.md @@ -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. + + diff --git a/.github/ISSUE_TEMPLATE/new_component_request.md b/.github/ISSUE_TEMPLATE/new_component_request.md new file mode 100644 index 000000000..21f81472f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/new_component_request.md @@ -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. + + diff --git a/CHANGELOG.md b/CHANGELOG.md index f75173859..2ae4ccfdd 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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) diff --git a/src/pages/docs/contributing.md b/src/pages/docs/contributing.md index e94a73a7f..6c3eb13dc 100644 --- a/src/pages/docs/contributing.md +++ b/src/pages/docs/contributing.md @@ -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)