Thank you for helping make AMP better by fixing bugs, adding features or improving the AMP code in some other way!
This document describes the process you will go through to make a change in AMP.
We want to make it as easy as possible to get in small fixes. A fix for a small bug should be as easy as creating a PR with the change, adding/fixing a test, and sending it to a reviewer.
- (optional) If you are fixing a bug and there is an existing GitHub issue, assign it to yourself or comment on it to let others know you are working on it. If there is no GitHub issue consider filing one, but for minor fixes your Pull Request description may be enough.
- (optional) Find a reviewer before you start coding to help you answer questions. If you don't have any questions you can find a reviewer once you have a PR ready.
- Follow the parts of the Implementation section that makes sense for your change. There are many parts of the process that you probably won't need to follow for a minor fix--e.g. you may not need to make validator changes or put your change behind an experiment for minor fixes. If in doubt ask your reviewer.
Significant changes (e.g. new components or significant changes to behavior) require consultation with and approval from knowledgeable members of the community.
- Before you start coding, find a reviewer who you can discuss your change with and who can help guide you through the process.
- File an Intent-to-implement (I2I) GitHub issue and cc your reviewer on it. The I2I should include:
- A description of the change you plan to implement.
- If you are integrating a third-party service, provide a link to the third-party's site and product.
- Details on any data collection or tracking that your change might require.
- A prototype or mockup (for example, an image, a GIF, or a link to a demo).
- Determine who needs to approve your I2I. Changes that have a significant impact on AMP's behavior or significant new features require the approval from the Approvers Working Group (WG). Work with your reviewer to determine whether your change is significant enough that it requires approval from the Approvers Working Group and/or any other Working Group.
- Get pre-approval from the Approvers WG if needed. For changes that require approval from the Approvers WG, at least 3 members of the Approvers WG should provide pre-approval on the I2I before significant implementation work proceeds.
- Finalize the design of your change.
- Familiarize yourself with our Design Principles.
- Your reviewer can help you determine if your change requires a design doc and whether it should be brought to a design review.
- Proceed with the implementation of your change.
- For changes that require approval from the Approvers WG, file an Intent-to-ship (I2S) issue. Indicate which experiment is gating your change and a rollout plan. Once this issue is approved by 3 members of the Approvers WG the rollout plan described in the I2S may proceed.
All code must be reviewed and approved as described in the Code review and approval section.
If you're making a minor fix and just want to find someone to review/approve your code, choose:
- an Owner from the OWNERS.yaml file in the directories you change (or their parent directories)
- and a Reviewer
(It is acceptable for one person to fulfill both roles.)
After you've found your reviewers:
- add them as reviewers on your PR if you are able to
- or cc them by adding the text "/cc @username" in the PR description/comment
If the reviewers you find aren't responsive, ping the #contributing channel on Slack. You can also reach out to mrjoro on Slack or cc him on your GitHub issue/PR.
A reviewer is needed if you are making a more substantial change to AMP. A reviewer is a member of the AMP community who is knowledgeable about the area you are modifying and who can guide you from the design phase all the way through launch.
To find a reviewer:
- The Working Group that is most responsible for the area you are changing may document how to find a reviewer from that Working Group. If they do not, reach out to the facilitator of the WG (on Slack or by ccing them on your GitHub issue by adding "/cc @username" in the issue body or comment).
- If there is no obvious Working Group responsible for the area you are changing but you know what part of the codebase your change will be in, reach out to one of the people in the OWNERS.yaml files for the areas you're changing (on Slack or by ccing them on your GitHub issue).
- If you're still not sure who your reviewer should be, ask for a reviewer on Slack in the #contributing channel.
- If you can't find a reviewer after going through these routes or the reviewers you find aren't responsive, reach out to mrjoro on Slack or cc him on your GitHub issue/PR.
Once you have found a reviewer, make sure to @-mention them on any issues / PRs related to your change (e.g. if mrjoro is your reviewer you can just add "/cc @mrjoro" in the issue/PR body or comment).
- (optional) Join AMP on GitHub. You don't need to wait to be added to the org before you start coding.
- Perform the one-time setup if needed: Set up your GitHub account, install Node, Yarn, Gulp CLI, fork repo, track repo, etc.
- Create a working branch.
- Build AMP.
- Write your code.
- For more substantial changes, multiple smaller PRs are preferable to one large PR. These will be easier to review and can prevent wasted work.
- Consult these resources for guidance and guidelines:
- Design: AMP Design Principles
- JavaScript: Google JavaScript Code Style Guide
- CSS: Writing CSS For AMP Runtime
- Creating new components:
- Instructions and Guidelines for building an AMP component
- Learn to create your first component in this codelab
- Watch this YouTube video to learn about "Building a new AMP component"
- Integrating third-party software, embeds, services: Guidelines
- Put your change behind an experiment flag unless it is a minor fix or your reviewer indicates this is not needed.
- Commit your files.
- Test your changes.
- A key feature of AMP is performance. All changes will be analyzed for any performance impact; we particularly appreciate changes that make things even faster. Please include any measured performance impact with substantial pull requests.
- Prepare for your code review.
- For more substantial changes, it's usually preferable to have your code reviewed before you make a significant investment in new tests, examples, etc.
- Before your final review, make sure your change:
- Send your code for review.
- Sign the Contributor License Agreement if you have not already done so.
- Pull the latest changes from the amphtml repo and resolve any conflicts.
- Run the pre push check, which is a tool that helps catch any issues before you submit your code. To enable the git pre-push hook, see
enable-git-pre-push.sh. - Push your changes
- Create a Pull Request (PR).
- Make sure the presubmit checks shown on your PR on GitHub passes (e.g. no lint and type check errors, tests are passing).
- Add reviewers to your PR that will fulfill the requirements of code review and approval documented in the Code review and approval section. (Your reviewer can help with this.)
- Respond to feedback.
- After your PR has all of the necessary approvals, your code may be merged into the repository by any Collaborator/Reviewer. Your reviewer will typically handle this; reach out to them if your code is not merged soon after it has been approved.
- To check on your changes and find out when they get into production, read See your changes in production.
- Clean up: After your changes are merged, you can delete your working branch.
AMP is designed to be extensible - it is meant to support “Extended Components” that provide first-class support for additional rich features.
Because Extended Components may have significant impact on AMP performance, security, and usage, Extended Component contributions will be very carefully analyzed and scrutinized.
In particular, we strive to design the overall component set, so that a large number of use cases can be composed from them. Instead of creating a new component it may thus be a better solution to combine existing components to a similar effect.
We have a few additional resources that provide an introduction to contributing extended components:
- "Building an AMP Extension" has a detailed description of how to build an AMP component.
- "Creating your first AMP Component" codelab provides a quick overview of the steps you need to go through to create a component with examples you can modify for your component.
- The "Building a new AMP component" talk at AMP Conf 2017 provides an introduction to contributing AMP components.
For further detail on integrating third-party services (e.g., fonts, embeds, etc.), see our 3p contribution guidelines.
AMP requires all contributors to either sign an individual Contributor License Agreement or be covered by a corporate Contributor License Agreement in order to protect contributors and users in issues of intellectual property.
We recommend you handle signing/being covered by a CLA before you send a PR to avoid problems, though this is not absolutely necessary until your code is ready to be merged in.
Make sure that the email you associate with your CLA is the same email address you associate with your commits (likely via the user.email Git config as described on GitHub's Set up Git page).
- If you are contributing code on your own behalf you can sign the individual CLA instantly online.
- If you are planning on contributing code on behalf of your company:
- Your company will need to agree to a corporate CLA if it has not already done so. Although this is a relatively straightforward process, it requires approval from an authorized signer at your company and a manual verification process that may take a couple of days. To ensure you can get your code reviewed and merged quickly please start this process as soon as possible. The signer of your corporate CLA will associate a Google Group to the corporate CLA, and any email address added to this Google Group will be considered to be covered by this corporate CLA.
- To be covered by your company's corporate CLA the owner of the Google Group associated with the corporate CLA (someone at your company) will need to add your address to this Google Group.
- If you aren't sure whehther your company has already signed a corporate CLA, if you don't know who at your company owns the Google Group you need to be added to, or you run into any other questions about the corporate CLA, please reach out to @mrjoro (via cc on a PR or on Slack (signup)) or the #contributing channel on Slack.
All code in AMP must be reviewed and approved before it is merged. Reviewers/Collaborators primarily ensure that the code is correct, efficient and consistent with existing AMP code while Owners primarily provide a domain-specific review of the code.
To be merged, all code must be approved by both:
- At least one Reviewer who is not the author. If the author is a Reviewer, a Collaborator may fulfill this requirement instead.
- At least one Owner for all areas the PR affects, except those areas in which the code author is an Owner.
It is acceptable for one person to fulfill these requirements, e.g. if an Owner who is also a Reviewer approves the PR it may be merged.
Once the PR has been approved, anyone with commit rights to the repository may merge the PR, including its author.
These guidelines are specific to the amphtml repository. Other ampproject repos may follow the same guidelines or use different guidelines as documented in their CONTRIBUTING.md files.
- Review, approve and merge PRs in the repository for which they are Collaborators.
- Collaborator status is granted to folks who have proven basic familiarity with the respective repository.
- A person may become a Collaborator after 2 merged PRs that are non-trivial (not only fixing typos, not only config changes) and a +1 from 1 current Reviewer. To request becoming a Collaborator file an issue in the repository in which you are requesting to be a Collaborator and cc a Reviewer in that repository.
- The list of Collaborators is maintained in the Collaborators (amphtml) GitHub team.
- Review, approve and merge PRs in the repository for which they are Reviewers.
- Reviewer status is granted to folks who have demonstrated deep familiarity with the code-style and conventions of the respective repository.
- A person may become a Reviewer after 10 merged PRs or 10 high quality reviews of complex PRs and a +1 from 1 current Reviewer. Qualifying PRs must be non-trivial (not only fixing typos, not only config changes) and should have implemented or documented at least 2 new features. To request becoming a Reviewer file an issue in the repository in which you are requesting to be a Reviewer and assign/cc a Reviewer in that repository.
- The list of Reviewers is maintained in the Reviewers (amphtml) GitHub team.
- Review & approve PRs in the area in which they have expertise.
- Requirements to be an Owner:
- Demonstrated expertise in the area in which they are an Owner.
- Any GitHub user (including those who are not Reviewers or Collaborators) may be an Owner.
- When creating a new directory (such as when creating a new AMP extension) the author of the pull request should designate themselves as an Owner of that directory.
- Owners of an area may approve other Owners at or below their area of expertise following the normal PR process. To request becoming an Owner create a PR adding yourself to the appropriate OWNERS.yaml file and assign/cc a current Owner for that directory.
- The list of Owners for a directory can be found in the OWNERS.yaml file in the directory or a parent directory.