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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
5 changes: 3 additions & 2 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@
- If you have questions about how to use AMP or other general questions about AMP please ask them on Stack Overflow under the AMP HTML tag instead of filing an issue here: http://stackoverflow.com/questions/tagged/amp-html
- If you have questions/issues related to Google Search please ask them in Google's AMP forum instead of filing an issue here: https://goo.gl/utQ1KZ

If you have a bug or feature request for AMP please fill in the following template. Delete everything except the headers (including this text).
If you have a bug or feature request for AMP please fill in the following template. Delete everything except the headers (including this text).

## What's the issue?

Briefly describe the bug/feature request.

## How do we reproduce the issue?

If this is a bug please provide a public URL and ideally a reduced test case (e.g. on jsbin.com, codepen.io, or glitch.com) that exhibits only your issue and nothing else. Then provide step-by-step instructions for reproducing the issue:
If this is a bug please provide a public URL and ideally a reduced test case (e.g. on jsbin.com, codepen.io, or glitch.com) that exhibits only your issue and nothing else. Then provide step-by-step instructions for reproducing the issue:

1. Step 1 to reproduce
2. Step 2 to reproduce
Expand All @@ -20,6 +20,7 @@ If this is a bug please provide a public URL and ideally a reduced test case (e.
If this is a feature request you can use this section to point to a prototype/mockup that will help us understand the request.

### Tips on Rendering Bugs

If you're reporting a bug that's the result of rendering data from an endpoint (e.g. with `<amp-list>` or `<amp-form>`), it's helpful to include sample JSON data from your endpoint. [JSONPlaceholder](https://jsonplaceholder.typicode.com/) is great for providing publicly accessible sample endpoint as well as dummy json endpoints.

## What browsers are affected?
Expand Down
19 changes: 12 additions & 7 deletions .github/ISSUE_TEMPLATE/cherry_pick_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,26 +10,29 @@ MUST: Replace *everything* in angle brackets in the title AND body of this issue

If you have any questions see the [cherry-pick documentation](https://github.com/ampproject/amphtml/blob/master/contributing/release-schedule.md#cherry-picks).
-->

# Cherry-pick request

<!--
TIP: Cherry-picks into production most likely require a cherry-pick into RC too. Otherwise, your fix will be lost when the RC is promoted.
-->

| Issue | PR | Production? | RC? | [Release issue](https://github.com/ampproject/amphtml/labels/Type%3A%20Release) |
| :---: | :-: | :---------: | :-: | :-----------: |
| #<_ISSUE_NUMBER_> | #<_PR_NUMBER_> | **<YES/NO>** | **<YES/NO>** | #<_RELEASE_ISSUE_> |
| Issue | PR | Production? | RC? | [Release issue](https://github.com/ampproject/amphtml/labels/Type%3A%20Release) |
Comment thread
rsimha marked this conversation as resolved.
| :---------------: | :------------: | :----------: | :----------: | :-----------------------------------------------------------------------------: |
| #<_ISSUE_NUMBER_> | #<_PR_NUMBER_> | **<YES/NO>** | **<YES/NO>** | #<_RELEASE_ISSUE_> |

## Why does this issue meet the [cherry-pick criteria](https://github.com/ampproject/amphtml/blob/master/contributing/release-schedule.md#cherry-pick-criteria)?

<!--
TIP: Be specific.
-->

<_YOUR_REASONS_>

<!--
CONDITION: Cherry-picking into production but _not_ RC. Otherwise, delete.
-->

## Why is a RC cherry-pick not needed?

<_YOUR_REASONS_>
Expand All @@ -39,6 +42,7 @@ MUST: Filling out the mini-PM template is required _after_ the deployment of a p

MUST: This issue cannot be closed until the mini-PM is written and its action items are completed.
-->

# Mini-postmortem

> **TODO:** This postmortem will be written after the cherry-pick deployment and before this issue is closed. Delete this TODO when the postmortem is ready.
Expand All @@ -48,10 +52,11 @@ MUST: This issue cannot be closed until the mini-PM is written and its action it
<!--
TIP: A few sentences summarizing the problem and impact.
-->

<_YOUR_SUMMARY_>

| Users affected | Impact |
| -------------- | ------ |
| Users affected | Impact |
| ------------------------------------------------ | ---------------------------------------------------------------------------- |
| <_Which users were affected? Roughly how many?_> | <_How were users affected? E.g. partial or complete loss of functionality?_> |

## Root Causes
Expand All @@ -60,8 +65,8 @@ TIP: A few sentences summarizing the problem and impact.

## Action Items

| Action Item | Type | Owner | PR # |
| ----------- | :--: | :---: | :--: |
| Action Item | Type | Owner | PR # |
| ----------------------------- | :------------------------------: | :-----------: | :------------: |
| <_E.g. Add integration test_> | <_Investigate/Mitigate/Prevent_> | @<_USERNAME_> | #<_PR_NUMBER_> |

## Lessons Learned
Expand Down
6 changes: 6 additions & 0 deletions .github/ISSUE_TEMPLATE/intent-to-deprecate--i2d-.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,31 +16,37 @@ If your feature can be removed immediately after deprecation, you can use this i
-->

## Summary

<!--
Provide a brief description of the feature you are planning on deprecating and a concrete plan for deprecating the feature. Provide the detailed removal plan if the feature is ready for immediate removal after deprecation, otherwise provide an initial plan for removing the deprecated feature and file a separate Intent-to-Remove issue after this issue is approved.
-->

## Motivation

<!--
Explain why this feature needs to be deprecated and eventually removed.
-->

## Impact on existing users

<!--
How seriously would the removal of this feature break sites that currently use AMP? If available what is the estimated usage of this feature?
-->

## Alternative implementation suggestion for developers using AMP

<!--
When the feature you are deprecating is removed, how would developers using AMP achieve similar functionality?
-->

## Additional context

<!--
Add any other information that may help people understand your I2D.
-->

<!--
Add anyone to this cc line that you want to notify about this I2D.
-->

/cc @ampproject/wg-approvers
9 changes: 8 additions & 1 deletion .github/ISSUE_TEMPLATE/intent-to-implement--i2i-.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,33 +16,40 @@ If you haven't already done so, sign the Contributor License Agreement (CLA) as
-->

## Summary

<!--
Provide a brief description of the feature/change you are planning on implementing.
-->

## Design document

<!--
Provide a link to your design document once you have one. You do not need a design document to file this I2I.
-->

## Motivation

<!--
Explain why AMP needs this change. It may be useful to describe what AMP developers/users are forced to do without it. When possible, include links to back up your claims.
-->

A clear and concise description of any alternative solutions or features you've considered.

## Additional context

<!--
Add any other information that may help people understand your I2I.
-->

## Launch tracker

<!--
The launch tracker is meant to be an easy way of sharing a project's status with others on the AMP Project.
The launch tracker is meant to be an easy way of sharing a project's status with others on the AMP Project.
You should add a link to the launch tracker for this work here if applicable. One ideal template and instructions can be found here: bit.ly/amp-launch-tracker
-->

<!--
Add anyone to this cc line that you want to notify about this I2I, including a reviewer once you have found one. See https://github.com/ampproject/amphtml/blob/master/contributing/contributing-code.md for help in finding a reviewer.
-->

/cc @ampproject/wg-approvers
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/intent-to-remove--i2r-.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,28 +16,33 @@ This I2R should be created after your Intent-to-Deprecate (I2D) for the feature
-->

## Summary

<!--
Provide a brief description of the deprecated feature you are removing.

Link to the Intent-to-Deprecate (I2D) describing more context on the deprecation.
-->

## Rollout plan

<!--
Detail the steps you will use to remove this deprecated feature.
-->

## Alternative implementation suggestion for developers using AMP

<!--
When the feature you are deprecating is removed, how can developers using AMP achieve similar functionality?
-->

## Additional context

<!--
Add any other information that may help people understand the I2R.
-->

<!--
Add anyone to this cc line that you want to notify about this I2R.
-->

/cc @ampproject/wg-approvers
8 changes: 7 additions & 1 deletion .github/ISSUE_TEMPLATE/intent-to-ship--i2s-.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,37 +16,43 @@ See https://github.com/ampproject/amphtml/blob/master/CONTRIBUTING.md for more i
-->

## Summary

<!--
Provide a brief description of the feature/change you have implemented.
-->

## Intent-to-implement (I2I) issue

<!--
Provide a link to the I2I issue you filed for this feature/change.
-->

## Experiment(s) to enable

<!--
List the experiment(s) that should be enabled to launch your feature.
-->

## Required release version

<!--
Link to the "Type: Release" issue for the release that contains all of the changes necessary for your launch.
-->

## Demo instructions

<!--
Provide instructions for how to demo your feature such as a link to a demo page.
-->

## Additional context

<!--
Add any other information that may be relevant in determining if your feature can ship.
-->


<!--
Add anyone to this cc line that you want to notify about this I2S, including the reviewer who you worked with on the I2I.
-->

/cc @ampproject/wg-approvers
3 changes: 1 addition & 2 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

<!--
# Instructions:

Expand Down Expand Up @@ -32,4 +31,4 @@
⏪ Reverting a previous change
♻️ Refactoring
🚮 Deleting code
-->
-->
4 changes: 4 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@
"files": "OWNERS",
"options": {"parser": "json5"}
},
{
"files": "*.md",
"options": {"parser": "markdown"}
},
{
"files": [".eslintrc", ".prettierrc", ".renovaterc.json", "*.json"],
"options": {"parser": "json"}
Expand Down
3 changes: 2 additions & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,5 +24,6 @@
// https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode
"[yaml]": {"editor.formatOnSave": true},
"[json]": {"editor.formatOnSave": true},
"[json5]": {"editor.formatOnSave": true}
"[json5]": {"editor.formatOnSave": true},
"[markdown]": {"editor.formatOnSave": true}
}
9 changes: 5 additions & 4 deletions 3p/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Inclusion of third party software, embeds, and services into AMP

In general all inclusions are subject to [CONTRIBUTING.md](../CONTRIBUTING.md). This files outlines specific rules for certain types of external embed and other software inclusions.
In general all inclusions are subject to [CONTRIBUTING.md](../CONTRIBUTING.md). This files outlines specific rules for certain types of external embed and other software inclusions.

In order to qualify for inclusion, an extended component that integrates a third-party service must generally meet the notability requirements of the English Wikipedia, and is in common use in Internet publishing. As a rough rule of thumb, it should be used or requested by 5% of the top 10,000 websites as noted on builtwith.com, or already integrated into [oEmbed](http://oembed.com/).
In order to qualify for inclusion, an extended component that integrates a third-party service must generally meet the notability requirements of the English Wikipedia, and is in common use in Internet publishing. As a rough rule of thumb, it should be used or requested by 5% of the top 10,000 websites as noted on builtwith.com, or already integrated into [oEmbed](http://oembed.com/).

We highly prefer integrations that do not use iframes. JSONP cannot be used for security reasons, but CORS requests are perfectly fine.

Expand Down Expand Up @@ -47,7 +47,7 @@ The following aren't hard requirements, but are performance optimizations we sho
- Creatives should only animate using CSS transforms and opacity.
- When creatives animate they should not use more than 2ms time per frame to allow for other animations to have sufficient time for concurrent animations.

The better an ad network does on the above requirements, the earlier ads from it will be loaded into AMP. In other words: *The slower the ad loads and the more it interferes with the page, the later AMP will load it.*
The better an ad network does on the above requirements, the earlier ads from it will be loaded into AMP. In other words: _The slower the ad loads and the more it interferes with the page, the later AMP will load it._
Comment thread
mrjoro marked this conversation as resolved.

We are also excited to start conversations how modern web tech could improve overall ads latency, memory usage and framerate impact and how AMP's open source model could be used to inject trust through an auditable common code base into the ads ecosystem which would reduce the necessity of redundant metrics collection.

Expand All @@ -62,8 +62,9 @@ Review the [ads/README](../ads/README.md) for further details on ad integration.
- If a font provider does referrer based "security" it needs to whitelist the AMP proxy origins before being included in the link tag whitelist. AMP proxy sends the appropriate referrer header such as `https://cdn.ampproject.org` and `https://amp.cloudflare.com`.

# Adding proper integration tests

You should ensure there are integration tests for your extension. These should be added to the AMP
repo where it makes sense. In some cases this won't be possible because it relies on bringing up
third-party infrastructure. In these cases you should maintain testing for the extension on your
infrastructure against both production AMP and [canary](https://github.com/ampproject/amphtml/blob/master/contributing/release-schedule.md#amp-dev-channel).
Upon any monitored failures, an escalation can be raised in [regular AMP communication channel](https://github.com/ampproject/amphtml/blob/master/CONTRIBUTING.md#discussion-channels).
Upon any monitored failures, an escalation can be raised in [regular AMP communication channel](https://github.com/ampproject/amphtml/blob/master/CONTRIBUTING.md#discussion-channels).
Loading