From ee11d4ac5b3ed2ff8ecf4192862491dbf330873d Mon Sep 17 00:00:00 2001 From: Joe Medley Date: Mon, 27 Mar 2023 08:19:13 -0700 Subject: [PATCH] Add a README template and instructions to use it. (#866) * Add README template. * Formatting * Add README instructions and link to CONTRIBUTING. --- CONTRIBUTING.md | 3 +++ README-template.md | 22 ++++++++++++++++++++++ 2 files changed, 25 insertions(+) create mode 100644 README-template.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 385c575b..0c6c0e6b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -46,3 +46,6 @@ cd chrome-extensions-samples # install dependencies npm install ``` +### Writing a README + +All code samples should include a README file. Please copy the [provided template](./README-template.md) into your sample's folder and follow the instructions therein. \ No newline at end of file diff --git a/README-template.md b/README-template.md new file mode 100644 index 00000000..2cff1d2e --- /dev/null +++ b/README-template.md @@ -0,0 +1,22 @@ +_To create a README for your sample_ + +1. _Copy this file to your sample folder._ +1. _Enter the requested information below._ +1. _Delete all intructions._ + + +_For API samples use the name of the API. For example, a sample about the `chrome.declarativeNetRequest` would simply be called "chrome.declarativeNetRequest". (Do not use special formatting in headings.) For functional samples, the title should be what the sample demonstrates_ + +# Title + +_Describe what the sample demonstrates. If this is an API sample, link to the API._ + +This sample demonstrates ... + +## Overview + +_Describe how the sample demonstrates the API or use case and briefly describe how to use it._ + +## Implementation Notes + +_Add any information that doesn't fit elsewhere in the README._