You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We welcome feedback, bug fixes, content & display improvements, and translations. Ultimately, what gets accepted and merged into the project is up to NewtonScript.org staff (specifically, [Morgan Aldridge](https://github.com/morgant), the current project maintainer), but you are encouraged to submit any suggestions.
5
4
6
-
Please submit errors/corrections, additions, and feature requests via [the newtonscript.github.com GitHub project's issue tracker](https://github.com/NewtonScript/newtonscript.github.com/issues).
5
+
Please submit errors/corrections, additions, and feature requests via the project’s [issue tracker](https://github.com/NewtonScript/newtonscript.github.com/issues).
7
6
8
-
WHAT YOU NEED
9
-
-------------
7
+
## What You Need
10
8
11
9
You will need the following to contribute:
12
10
13
11
* A [GitHub](http://github.com) account for submitting pull requests
14
-
* A familiarity with HTML5, CSS3 experience is a plus
12
+
* A familiarity with HTML5
13
+
* Experience with CSS3 is a plus
15
14
16
-
MAKING CHANGES
17
-
--------------
15
+
## Making Changes
18
16
19
17
Follow these steps when making changes. That way, they will most likely be accepted with few headaches and very little back and forth.
20
18
@@ -24,72 +22,72 @@ Follow these steps when making changes. That way, they will most likely be accep
24
22
4. Make commits in logical units and with explanatory commit messages.
25
23
5. Preview your changes in an HTML5-capable web browser to ensure nothing is broken and everything is rendering correctly.
26
24
27
-
SUBMITTING CHANGES
28
-
------------------
25
+
## Submitting Changes
29
26
30
27
When you’ve completed your changes and are ready to merge them into the main project, follow these steps to submit them for review.
31
28
32
-
1. Push the changes to your fork of the newtonscript.github.com project on GitHub
29
+
1. Push the changes to your fork of the [newtonscript.github.com](https://github.com/NewtonScript/newtonscript.github.com) project on GitHub
33
30
2. Submit a pull request to the [newtonscript.github.com](https://github.com/NewtonScript/newtonscript.github.com) project
34
31
35
32
That’s all there is to it.
36
33
37
-
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.
38
35
39
-
<aname="style-guide"></a>STYLE GUIDE
40
-
-----------
36
+
## Style Guide
41
37
42
-
## HTML
38
+
###HTML
43
39
44
40
* Please write well-formed HTML to the HTML5 specification.
45
41
* Please write pretty HTML with proper indentation for nested elements.
46
42
* Please use tabs instead of spaces for indentation.
47
43
48
-
## Text
44
+
###Text
49
45
50
46
* Please alphabetize referenced materials (software, source code, reference documentation, etc.) by title and authors by last name.
51
47
* For sub lists which are more appropriately listed in chronological order (e.g. lists of publication issues), please do so.
52
48
* Please use [serial commas](https://en.wikipedia.org/wiki/Serial_comma).
53
49
54
-
## Resource Template
50
+
###Resource Template
55
51
56
52
The following is the template used to list referenced resources (software, source code, documentation, etc.):
IMPORTANT: Whenever you link to a resource or its mirror, please visit http://archive.org/web/ and submit that URL to "Save Page Now" to ensure its preservation!
**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!
71
69
72
70
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:
73
71
74
-
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.
75
73
76
-
RESOURCE URL: The URL for the referenced resource.
74
+
`RESOURCE URL` — The URL for the referenced resource.
77
75
78
-
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 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).
79
77
80
-
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.
81
79
82
-
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.
83
81
84
-
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.
85
83
86
-
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.
87
85
88
-
LICENSE: (Optional, but should be included for software & source code).
86
+
`LICENSE` — Optional, but should be included for software and source code.
89
87
90
-
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.
91
89
92
-
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.
93
91
94
-
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.
Copy file name to clipboardExpand all lines: LICENSE.md
+1-2Lines changed: 1 addition & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,4 @@
1
-
LICENSE
2
-
=======
1
+
# License
3
2
4
3
This work is licensed under the [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License](http://creativecommons.org/licenses/by-nc-sa/4.0/).
0 commit comments