felixfoertsch/webextensions-examples
1
0
Fork 0
mirror of https://github.com/mdn/webextensions-examples.git synced 2026-04-17 14:59:12 +02:00
Code Issues Packages Projects Releases Wiki Activity

updates and typo fixes for CONTRIBUTING.md

Browse Source
This commit is contained in:
Will Bamberg
2016-01-06 14:39:11 -08:00
parent 83653eefa9
commit 9e53f21427
1 changed files with 6 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
CONTRIBUTING.md
View File

@@ -10,19 +10,20 @@ but also [manifest.json keys](https://developer.mozilla.org/en-US/Add-ons/WebExt
and more general techniques such as internationalization or message passing.
More specifically, they're intended to be referenced from the MDN documentation
for WebExtensions. So, for example, we'll expect the reference page to
tabs.executeScript to link to some examples that demonstrate how to use this
for WebExtensions. So, for example, we'll expect the reference page for
`tabs.executeScript()` to link to some examples that demonstrate how to use this
API.
So examples should:
* have a clear function, that's easy to explain and understand
* focus on demonstrating how to use of WebExtension technology, minimizing any
* focus on demonstrating how to use the WebExtension technology, minimizing any
complex logic that's extraneous to the WebExtension technology itself
* demonstrate good-practice use of the technology, even at the expense of extra
complexity
* include useful optional manifest.json keys: description, homepage_url
* include useful optional manifest.json keys: `description` and `homepage_url`
Finally, note that the examples are all made available under the
[Mozilla Public License 2.0](https://github.com/mdn/webextensions-examples/blob/master/LICENSE),
so any contributions must be [compatible with that license](https://www.mozilla.org/en-US/MPL/license-policy/).
so any contributions must be
[compatible with that license](https://www.mozilla.org/en-US/MPL/license-policy/).