Back to Amphtml

Good First Issues Template

docs/good-first-issues-template.md

latest5.2 KB
Original Source
<!-- Copy this template into new Great First Issues and edit as needed. --> <!-- [Optional] Include this section if you think the issue is perfect for people who have never contributed to open source projects before. -->

First Timers Only

We know figuring out the process for contributing to an open source project can be intimidating, so we created this issue as a way for you to learn the ropes. (If you feel comfortable contributing to open source projects, please leave this issue for someone else.)

<!-- List knowledge/skills the contributor should already have before working on this bug (for example, knowledge of web components, Node.js internals, etc.). New contributors can use this section to find bugs that match their existing skills. This also serves as a filter that can reduce the amount of explanation you will need to do in the "Step by step" section. Try to be only as restrictive as necessary and call out any nice-to-haves. -->

What you will need to know

<!-- [Optional] If there is additional context that will help the contributor fix the bug add it here. If this is redundant with other sections feel free to remove it. -->

Background

<!-- Explain why fixing this bug/feature is important, i.e. why should the contributor care about fixing this? Whose life will be made better by this fix? -->

Motivation

<!-- Detailed steps for reproducing the bug. If this is a feature, change this to "The feature" and add a detailed description. -->

The bug

<!-- Step-by-step instructions for the contributor to follow as they work through the bug. Feel free to change any step that will make the steps more clear for this issue. Make sure to replace the comment block below with the exact steps the contributor should follow. -->

Step by step

<!-- Add steps that are specific to the issue here, e.g. perhaps they should edit a test, run `amp unit` or `amp integration` to see it fails, change a file and then run test again to see that the new test succeeds? Adjust the level of detail for the background you indicated the contributor should have. --> <!-- Ideally suggest a reviewer for the Pull Request; not knowing who to set as the reviewer can be confusing for new contributors. --> <!-- If this issue is a change that won't go out with a push (e.g. a doc change, a fix to the build, etc.) update the sentence about how to see their change is live. -->

Once approved, your changes will be merged. ⚡⚡⚡Congrats on making your first contribution to AMP!⚡⚡⚡ You'll be able to see it live across the web soon!

Thanks, and we hope to see more contributions from you soon.

Questions?

<!-- Ideally provide a specific contact to @mention here as well -->

If you have questions ask in this issue or on your Pull Request (if you've created one) or see the How to get help section of the Getting Started guide.