Skip to content

Commit 20eb3db

Browse files
committed
Added initial style guide in CONTRIBUTING.md. Issue #5
1 parent bfc7094 commit 20eb3db

File tree

1 file changed

+34
-3
lines changed

1 file changed

+34
-3
lines changed

CONTRIBUTING.md

Lines changed: 34 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,9 @@ Follow these steps when making changes. That way, they will most likely be accep
1818

1919
1. Fork the [newtonscript.github.com](https://github.com/NewtonScript/newtonscript.github.com) project on GitHub.
2020
2. Create a topic branch from the `master` branch. Name your branch appropriately, reflecting the intended changes. (e.g. “new-license”, “style-overhaul”, or “responsive-design-fixes”)
21-
3. Make commits in logical units and with explanatory commit messages.
22-
4. Preview your changes in an HTML5-capable web browser to ensure nothing is broken and everything is rendering correctly.
21+
3. Make your edits (please try to conform to our [style guide](#style-guide)).
22+
4. Make commits in logical units and with explanatory commit messages.
23+
5. Preview your changes in an HTML5-capable web browser to ensure nothing is broken and everything is rendering correctly.
2324

2425
SUBMITTING CHANGES
2526
------------------
@@ -31,4 +32,34 @@ When you’ve completed your changes and are ready to merge them into the main p
3132

3233
That’s all there is to it.
3334

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 merged them.
35+
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.
36+
37+
<a name="style-guide"></a>STYLE GUIDE
38+
-----------
39+
40+
## HTML
41+
42+
* Please write well-formed HTML to the HTML5 specification.
43+
* Please write pretty HTML with proper indentation for nested elements.
44+
* Please use tabs instead of spaces for indentation.
45+
46+
## Text
47+
48+
* Please alphabetize referenced materials (software, source code, reference documentation, etc.) by title and authors by last name.
49+
* For sub lists which are more appropriately listed in chronological order (e.g. lists of publication issues), please do so.
50+
* Please use [serial commas](https://en.wikipedia.org/wiki/Serial_comma).
51+
52+
## Resource Template
53+
54+
The following is the template used to list referenced resources (software, source code, documentation, etc.):
55+
56+
<dt id="[RESOURCE-ANCHOR]"><a href="[RESOURCE URL]">[RESOURCE TITLE/NAME]</a></dt>
57+
<dd>
58+
<p>[RESOURCE DESCRIPTION]</p>
59+
<ul class="metadata">
60+
<li>Author: <a href="[AUTHOR/ORGANIZATION URL]">[AUTHOR/ORGANIZATION URL]</a></li>
61+
<li>Platform: [PLATFORM]</li>
62+
<li>License: ["Freeware"/"Shareware"/"Commercial"/"Open Source"]</li>
63+
</ul>
64+
</dd>
65+

0 commit comments

Comments
 (0)