Skip to content

Latest commit

 

History

History
30 lines (18 loc) · 2.89 KB

contributing.md

File metadata and controls

30 lines (18 loc) · 2.89 KB

#Contributing version 0.2.0

We are not concerned with who you are or how significant you think your contribution is. Start by corecting a typo. Then dive in to more significant changes. You can raise issues, issue a pull request or contribute to the wiki.

First Time on GitHub? Don't Know Where to Start? First thing is to Sign Up for GitHub.

After you have a GitHub account you can go straight to the article repository. Don't worry - you won't break anything (probably).

##Simple Editing Using Prose.io If you want an easier way to make changes, try this:

  1. Make sure you are logged into GitHub.
  2. In another tab or window go to http://prose.io/ and click on "Authorize of GitHub".
  3. If all goes according to plan, you should then be able to go to http://prose.io/#ASU-CPI/honest-pi and see a clearer path to edit any of the files you want.
  4. Just click on a file, start adding, deleting, changing ...
  5. When done, click the save icon on the right hand side, then click on the "Commit" button.

N.B.: when editing / viewing files in Prose.io, URL are not clickable - you will need to copy and paste URLs to follow them.

##Problems?

You can also help to build the data that will support the second part of this experiment - a research paper that will observe and report on the process of writing the first article - by recording any observations or thoughts on the process in this running file of notes on this process.

But if you want to learn a bit about GitHub first, try our beginner tutorial.

Formatting in GitHub requires the use of Markdown. But don't let that scare you. You can craft in Word, and then convert that to Markdown with this handy app. Or use Prose.io as described above where a few formatting buttons are available, and then use this cheat sheet for other functions.

A key guideline for contributing: Part of this experiment has shown us that GitHub is not an ideal a terrible platform for text collaboration. One big limitation is that multiple changes to one file submitted in a pull request cannot be selectively "accepted" as with, for example, a Word document. To accommodate this, changes submitted as pull requests should be limited to one line or, at most, one paragraph. For more substantial changes (e.g., discussions about major structural changes), you can raise an issue or talk about it on the wiki.