|
1 |
| -#How to Contribute |
2 | 1 |
|
3 |
| -To get started contributing to clean-slate you only need two things: |
4 |
| - |
5 |
| -1. A github account |
6 |
| -2. Some free time |
7 |
| - |
8 |
| -You can edit files either directly on github, or locally on your computer. The GitHub method is faster, |
9 |
| - but if you're a seasoned git/GitHub user you may prefer the local method. See the instructions below |
10 |
| - for your preferred method. |
11 |
| - |
12 |
| -##Editing on GitHub |
13 |
| - |
14 |
| -1. Sign in to your GitHub account (or [create one](https://github.com/join)) |
15 |
| -2. Go to the [Code for DC Clean Slate](https://github.com/codefordc/clean-slate) repository. |
16 |
| -3. [Fork the repository](https://guides.github.com/activities/forking/) |
17 |
| -4. In order for GitHub pages to build on your repository, you need to commit one code change on any |
18 |
| - file. Any change will work, so for now try just adding a space to the end of one of the markdown files |
19 |
| - (files whose names end in `.MD`) |
20 |
| -5. Now you're all set! To see your changes go to `<yourusername>.github.io/clean-slate` for example: if |
21 |
| - your username is "Crazycodingwombat" then your version of the site will show up at |
22 |
| - `crazycodingwombat.github.io/clean-slate`. |
23 |
| -6. When you're happy with your changes and want to contribute them to the main project, just |
24 |
| - [issue a pull request](https://guides.github.com/introduction/flow/) |
25 |
| - |
26 |
| - |
27 |
| -##Editing Locally on Your Computer |
28 |
| - |
29 |
| -1. Clone this repository on your machine. |
30 |
| -2. Make your changes locally |
31 |
| -3. Test your changes locally. -- `File://` protocol will break some parts of the site, so you are better off running a tiny local server to view the site. One way is to run `python -m SimpleHTTPServer` from the root directory of the project and then point your browser to [`localhost:8000`](http://localhost:8000) |
32 |
| -4. When you are satisfied with the result, push your changes to your github repository and [issue a pull request](https://guides.github.com/introduction/flow/) |
33 |
| - |
34 |
| -You can learn more at [guides.github.com](guides.github.com) |
0 commit comments