centersl/chrome-extensions-samples
1
0
Fork 0
mirror of https://github.com/GoogleChrome/chrome-extensions-samples.git synced 2026-03-26 13:19:49 +07:00
Code Issues Packages Projects Releases Wiki Activity

Add a README template and instructions to use it. (#866)

Browse Source 
* Add README template.

* Formatting

* Add README instructions and link to CONTRIBUTING.
This commit is contained in:
Joe Medley
2023-03-27 08:19:13 -07:00
committed by GitHub
parent 4aa6bdb595
commit ee11d4ac5b
2 changed files with 25 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
CONTRIBUTING.md
View File

@@ -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.

22
README-template.md Normal file
View File

@@ -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._