|
1 | 1 | CONTRIBUTING TO NewtonScript.org |
2 | 2 | ================================ |
3 | 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. |
| 4 | +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. |
8 | 5 |
|
9 | 6 | WHAT YOU NEED |
10 | 7 | ------------- |
11 | 8 |
|
12 | 9 | You will need the following to contribute: |
13 | 10 |
|
14 | | -* A [GithHub](http://github.com) account for submitting pull requests |
| 11 | +* A [GitHub](http://github.com) account for submitting pull requests |
15 | 12 | * A familiarity with HTML5, CSS3 experience is a plus |
16 | 13 |
|
17 | 14 | MAKING CHANGES |
18 | 15 | -------------- |
19 | 16 |
|
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: |
| 17 | +Follow these steps when making changes. That way, they will most likely be accepted with few headaches and very little back and forth. |
22 | 18 |
|
23 | | -1. Fork the [newtonscript.github.com](https://github.com/NewtonScript/newtonscript.github.com) project on GitHub |
24 | | -2. Create a topic branch (an appropriately named branch regarding the intended changes, e.g. "new-license", "style-overhaul", or "resonsive-design-fixes") 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. |
| 19 | +1. Fork the [newtonscript.github.com](https://github.com/NewtonScript/newtonscript.github.com) project on GitHub. |
| 20 | +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. |
27 | 23 |
|
28 | 24 | SUBMITTING CHANGES |
29 | 25 | ------------------ |
30 | 26 |
|
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: |
| 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. |
34 | 28 |
|
35 | | -1. Push your 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 project on GitHub |
36 | 30 | 2. Submit a pull request to the [newtonscript.github.com](https://github.com/NewtonScript/newtonscript.github.com) project |
37 | 31 |
|
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. |
| 32 | +That’s all there is to it. |
| 33 | + |
| 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. |
0 commit comments