Skip to content

Commit 844c12e

Browse files
committed
Style guide code formatting, educated quotes
1 parent 7211525 commit 844c12e

File tree

1 file changed

+27
-24
lines changed

1 file changed

+27
-24
lines changed

CONTRIBUTING.md

Lines changed: 27 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@ Please submit errors/corrections, additions, and feature requests via the projec
99
You will need the following to contribute:
1010

1111
* A [GitHub](http://github.com) account for submitting pull requests
12-
* A familiarity with HTML5, CSS3 experience is a plus
12+
* A familiarity with HTML5
13+
* Experience with CSS3 is a plus
1314

1415
## Making Changes
1516

@@ -30,7 +31,7 @@ When you’ve completed your changes and are ready to merge them into the main p
3031

3132
That’s all there is to it.
3233

33-
If you followed the “Making Changes” guidelines and the changes are aligned with the vision of the project, it should be a smooth process to merged them.
34+
If you followed the “Making Changes” guidelines and the changes are aligned with the vision of the project, it should be a smooth process to merge them.
3435

3536
## Style Guide
3637

@@ -50,41 +51,43 @@ If you followed the “Making Changes” guidelines and the changes are aligned
5051

5152
The following is the template used to list referenced resources (software, source code, documentation, etc.):
5253

53-
<dt id="[RESOURCE-ANCHOR]"><a href="[RESOURCE URL]">[RESOURCE TITLE/NAME]</a></dt>
54-
<dd>
55-
<p>[RESOURCE DESCRIPTION]</p>
56-
<ul class="metadata">
57-
<li>Author: <a href="[AUTHOR/ORGANIZATION URL]">[AUTHOR/ORGANIZATION NAME]</a></li>
58-
<li>Platform: [PLATFORM]</li>
59-
<li>License: ["Freeware"/"Shareware"/"Commercial"/"Open Source"]</li>
60-
<li>Format: ["TXT"/"HTML"/"PDF"/"Book"/"Magazine"/"Video"]</li>
61-
<li>Mirror: <a href="[MIRROR URL]">[MIRROR TITLE/NAME]</a></li>
62-
</ul>
63-
</dd>
54+
```html
55+
<dt id="[RESOURCE-ANCHOR]"><a href="[RESOURCE URL]">[RESOURCE TITLE/NAME]</a></dt>
56+
<dd>
57+
<p>[RESOURCE DESCRIPTION]</p>
58+
<ul class="metadata">
59+
<li>Author: <a href="[AUTHOR/ORGANIZATION URL]">[AUTHOR/ORGANIZATION NAME]</a></li>
60+
<li>Platform: [PLATFORM]</li>
61+
<li>License: [“Freeware”/”Shareware”/”Commercial”/”Open Source”]</li>
62+
<li>Format: [“TXT”/”HTML”/”PDF”/”Book”/”Magazine”/”Video”]</li>
63+
<li>Mirror: <a href="[MIRROR URL]">[MIRROR TITLE/NAME]</a></li>
64+
</ul>
65+
</dd>
66+
```
6467

6568
**Important:** Whenever you link to a resource or its mirror, please visit the [Internet Archive Wayback Machine](http://archive.org/web/) and submit that URL to “Save Page Now” to ensure its preservation!
6669

6770
Please reference the following descriptions of the fields from the above template, as well as existing examples on the site, when adding a referenced resource:
6871

69-
RESOURCE-ANCHOR: (Optional) A unique HTML anchor for the reference if it'll be frequently linked to.
72+
`RESOURCE-ANCHOR` A unique anchor value for the reference. This accommodates direct linking to the reference. Optional.
7073

71-
RESOURCE URL: The URL for the referenced resource.
74+
`RESOURCE URL` The URL for the referenced resource.
7275

73-
RESOURCE TITLE/NAME: The title or name of the referenced resource. This should be in proper title case, with the exception of software/source code where the project's name itself may not be in proper title case. A common abbreviation for the resource title (e.g. "NTK") may optionally be included).
76+
`RESOURCE TITLE/NAME`The title or name of the referenced resource. This should be in proper title case, with the exception of software/source code where the projects name itself may not be in proper title case. A common abbreviation for the resource title (e.g. NTK) may optionally be included).
7477

75-
RESOURCE DESCRIPTION: A short, one to three sentence summary of the resource. For software, this should include its functionality and how NewtonScript comes into play. For reference material, it should describe what the documentation covers. For periodicals as a whole where individual issues or articles may also be available, it is suggested that those issues/articles be linked to in a list following this section.
78+
`RESOURCE DESCRIPTION`A short summary (one to three sentences) of the resource. For software, this should include its functionality and how NewtonScript comes into play. For reference material, it should describe what the documentation covers. For periodicals as a whole where individual issues or articles may also be available, it is suggested that those issues or articles be listed and linked individually following this section.
7679

77-
AUTHOR/ORGANIZATION URL: (Optional) The URL to the author or organization.
80+
`AUTHOR/ORGANIZATION URL` The URL to the author’s or organization’s site. Optional.
7881

79-
AUTHOR/ORGANIZATION NAME: The name of the person or organization that created or published the resource. Multiple names should be comma separated and placed in alphabetical order by last name. It is prefferable to always list all the authors or the specific organization, but in rare cases it may be appropriate to use "Various" instead.
82+
`AUTHOR/ORGANIZATION NAME`The name of the person or organization that created or published the resource. Multiple names should be comma separated and placed in alphabetical order by last name. It is preferable to list all authors or the specific organization. In rare cases, it may be appropriate to use Various instead.
8083

81-
PLATFORM: (Optional, but should be included for software & source code) The name of the platform which the resource was developed for. If multiple platforms are supported, they should be comma separated and in alphabetcal order. For non-Newton platforms, the general platform type is suggested (e.g. "Mac OS", "Mac OS X", "Windows", "Linux", "BSD", "BeOS", etc.), but for Newton platforms, the specific Newton OS version should be included (e.g. "NewtonOS 1.x", "NewtonOS 2.x", "NewtonOS 2.1", etc.)
84+
`PLATFORM`The name of the platform which the resource was developed for. If multiple platforms are supported, they should be comma separated and in alphabetical order. For non-Newton platforms, the general platform type is suggested (e.g. Mac OS”, “Mac OS X”, “Windows”, “Linux”, “BSD”, “BeOS, etc.). For Newton platforms, the specific Newton OS version should be included (e.g. “Newton OS 1.x”, “Newton OS 2.x”, “Newton OS 2.1, etc.) Optional, but should be included for software and source code.
8285

83-
LICENSE: (Optional, but should be included for software & source code).
86+
`LICENSE`Optional, but should be included for software and source code.
8487

85-
FORMAT: (Optional, but should be included for documentation) The format which the documentation is available in. If multiple formats are available, they should be comma separated and can optionslly link directly to the specified format.
88+
`FORMAT`The format which the documentation is available in. If multiple formats are available, they should be comma separated and may link directly to the specified format. Optional, but should be included for documentation.
8689

87-
MIRROR URL: (Optional, but should be included whenever available) The URL for an alternate source for the resource.
90+
`MIRROR URL`The URL of an alternate source for the resource. Optional, but should be included whenever available.
8891

89-
MIRROR TITLE/NAME: (Optional, but should be included whenever available) The nsme of an alternate source for the resource.
92+
`MIRROR TITLE/NAME` The name of an alternate source for the resource. Optional, but should be included whenever available.
9093

0 commit comments

Comments
 (0)