Skip to content

Latest commit

 

History

History
46 lines (27 loc) · 4.22 KB

design-reviews.md

File metadata and controls

46 lines (27 loc) · 4.22 KB
Raw

Design Reviews

The AMP Project community holds weekly design reviews via video conference on Wednesdays at 1pm Pacific.

The GitHub issue for a given week's design review will have links to the designs being discussed that week. When the design review is over the GitHub issue will include notes from the design review discussion.

When attending a design review please read through the designs before the review starts.

Bringing your design to a design review

If the design for an issue/feature you are working on has a scope larger than you can cover in a discussion in the GitHub issue or one of the other discussion channels, consider bringing it to a design review.

Note that the design review is optional and is not required for every new feature or bug fix.

The process for bringing a design to the design review is as follows:

  • Create a software design document in a shared Google Document open to public comments.

    • A short design doc is fine as long as it covers your design in sufficient detail to allow for a review by other members of the community.
    • Take a look at Design docs - A design doc for tips on putting together a good design doc. Phone call tracking in AMP and New AMP Boilerplate are examples of past AMP Project design docs.
    • Add this license text to the top of your design doc before sharing it with anyone else in the community (updating the year if necessary): 
      Copyright 2017 The AMP HTML Authors. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS-IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

See the License for the specific language governing permissions and limitations under the License.

  • Perform a design pre-review with at least one core committer; you can request a pre-review in the #design-review Slack channel (sign up). It is fine to request a pre-review before your design doc is complete.

  • When your design is ready to be discussed at a design review add a comment on the appropriate Design Review GitHub issue. Post a link to the design doc and a brief summary by 1pm Pacific Monday on the week of your design review.

  • Update your design based on the feedback in the design review and any followup conversations in other channels. Once your design is finalized, please provide a brief update at the start of a future design review (if you are able to attend) and submit a PDF version of your design doc in the ampproject design-doc repository.

Although design documents are strongly encouraged, for some smaller features a well-documented design in its own GitHub issue may be sufficient for a design review.

Flexible design review time

If you have a design you would like to present but can never make the 1pm Pacific design review (e.g. you are in a different time zone) please reach out in an upcoming design review issue or on Slack (sign up) and we will try to find a time that works for you.