Skip to content

Commit f100697

Browse files
committed
Updated README.md & added new CONTRIBUTING.md document.
1 parent 5eaa594 commit f100697

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

CONTRIBUTING.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
CONTRIBUTING TO NewtonScript.org
2+
================================
3+
4+
We welcome feedback, bug fixes, content & display improvements, and
5+
translations. Ultimately, what gets accepted and merged into the project is up
6+
to NewtonScript.org staff (specifically, Morgan Aldridge, the current project
7+
maintainer), but you are encouraged to submit your improvements.
8+
9+
WHAT YOU NEED
10+
-------------
11+
12+
You will need the following to contribute:
13+
14+
* A [GithHub](http://github.com) account for submitting pull requests
15+
* A familiarity with HTML5
16+
17+
MAKING CHANGES
18+
--------------
19+
20+
You will need to do the following to make changes that are most likely to be
21+
accepted with little headache and back & forth:
22+
23+
1. Fork the [newtonscript.github.com](https://github.com/NewtonScript/newtonscript.github.com) project on GitHub
24+
2. Create a topic branch from the `master` branch
25+
3. Make commits in logical units and with properly explanatory commit messages
26+
4. Preview your changes in an HTML5-capable web browser to ensure nothing broke and everything is rendering appropriately.
27+
28+
SUBMITTING CHANGES
29+
------------------
30+
31+
When you've completed your changes and are ready for them to be merged into the
32+
main project, you can do the following to submit them for review and likely
33+
inclusion in NewtonScript.org:
34+
35+
1. Push your changes to your fork of the newtonscript.github.com project on GitHub
36+
2. Submit a pull request to the [newtonscript.github.com](https://github.com/NewtonScript/newtonscript.github.com) project
37+
38+
That's all there is to it. If you followed the "Making Changes" guidelines and
39+
the changes are aligned with the vision of the project, it should be a pretty
40+
smooth process to get them merged in.

0 commit comments

Comments
 (0)