Skip to content

Commit

Permalink
add spaces after ATX-style headers in markdown
Browse files Browse the repository at this point in the history
per new GitHub interpretation
  • Loading branch information
JonathanReeve committed Apr 27, 2017
1 parent 254e1b1 commit 29cfdf8
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 12 deletions.
16 changes: 8 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
#How to Contribute
# How to Contribute
This is a guide for contributing to the open critical edition of James Joyce’s _A Portrait of the Artist as a Young Man_. It assumes no prior technical experience. It was initially written for students in the course “James Joyce,” taught at Columbia University in Fall 2016, but other contributors can use it, as well.

##Step 1: Sign up for a GitHub account.
## Step 1: Sign up for a GitHub account.
GitHub accounts are free, and you can sign up for one at [github.com](https://github.com/). Try to make sure your real name and main email address are shown somewhere in your user profile, so that your work can be properly credited to you.

##Step 2: Choose something to contribute.
## Step 2: Choose something to contribute.
There are already lots of plans for new features and things in [the project issue tracker](https://github.com/JonathanReeve/corpus-joyce-portrait-TEI/issues), so you could choose one of those issues to work on. The easiest issues are [the ones with the markup flag](https://github.com/JonathanReeve/corpus-joyce-portrait-TEI/issues?q=is:open+is:issue+label:markup). You can also try answering one of [the open questions in the tracker](https://github.com/JonathanReeve/corpus-joyce-portrait-TEI/issues?utf8=✓&q=is:open%20is:issue%20label:question).

Once you choose something to work on, make sure to leave a note in that issue so that others won’t be working on the same thing. For example, let’s say you want to work on marking up dialog for part of Chapter 2. First, see if an issue exists for that by looking through the list of issues. It does--it’s [issue #7: add dialog attribution with format <said who="">](https://github.com/JonathanReeve/corpus-joyce-portrait-TEI/issues/7). Next, look through the comments for that issue to make sure no one else is already working on that section. Then, log in to GitHub, and leave a comment at the bottom of that issue, saying something like “I’ll start working on dialog attribution for part of Chapter 2.”

##Step 3: Fork the project.
## Step 3: Fork the project.
“Forking” is just coding jargon for making a copy of a project. To fork the project, go to [the project homepage](https://github.com/JonathanReeve/corpus-joyce-portrait-TEI), and click the “Fork” button in the upper right corner:

![Fork](assets/fork.png)

This will create a copy of the project in your user account where you will make all of your changes. Now your copy lives at `github.com/your-username-here/corpus-joyce-portrait-TEI`. Navigate to your fork’s homepage, if you’re not already there. You can also find it by going to your profile page and clicking the “repositories” tab.

##Step 4: Make your edits.
## Step 4: Make your edits.
Portrait.xml is the name of the main TEI XML file for the novel. To browse through it, you can find it [here on the project site](https://github.com/JonathanReeve/corpus-joyce-portrait-TEI/blob/gh-pages/portrait.xml), but to edit it, you’ll have to find this file on your fork. To do that, go to your fork, click the “Code” tab, and click “portrait.xml” in the file listing. You can also navigate to the URL `https://github.com/your-username-here/corpus-joyce-portrait-TEI/blob/gh-pages/portrait.xml`, replacing `your-username-here` with your GitHub username. Now you should see something like this:

![XML](assets/xml.png)
Expand All @@ -40,14 +40,14 @@ If you’re not already used to XML, there are a couple things to note here.

If you want a quick introduction to XML, check out [the w3schools introduction](http://www.w3schools.com/xml/xml_whatis.asp), a 10-minute read at most. If you want a more TEI-specific guide, the [TEI Lite Introduction](http://www.tei-c.org/release/doc/tei-p5-exemplars/html/tei_lite.doc.html) is good.

##Step 5: Commit your changes.
## Step 5: Commit your changes.
Now that you’ve made all your changes for this round (you might want to make another, separate set of changes later), you can commit your changes, and describe what it is that you did. **Please reference the issue that you're working on.** For this dialog attribution example, I’ve described my change as `Add dialog attribution to Chapter 2, for issue #7`, and added an additional description that `It was difficult to find Mrs. Dedalus’s first name!`.

![Commit](assets/commit.png)

Repeat steps 4-5 as necessary, until you’re done making your changes.

##Step 6: Submit a pull request with your changes.
## Step 6: Submit a pull request with your changes.
Now that you’ve made your changes, you’ll want to submit them to the main edition for approval. A “pull request” is a request to the main project to integrate the changes you made on your fork. To submit a pull request, go to your fork’s homepage, i.e. `github.com/your-username-here/corpus-joyce-portrait-tei` and click the button labeled “Pull request”:

![Pull request](assets/pr.png)
Expand All @@ -60,7 +60,7 @@ Write a description of all the edits you committed. In this example, I wrote rou

Before clicking “Create pull request,” scroll down and review your changes once more. If everything looks good, create the pull request.

#What Tags To Use
# What Tags To Use

* Attribute dialog by surrounding it with `<said who="">` and `</said>`
* Mark up poetry (and verse more generally) by surrounding stanzas with `<lg>` (for “line group”) and lines with `<l>` (for “line”). End each stanza with `</lg>` and each line with `</l>`
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ We also mark up:

Apart from markup features, one of the distinguishing features of this project is its infrastructure. We leverage distributed version control using git and GitHub, which allows anyone to edit the edition in the browser and submit a request for the change.

##Markup Conventions
## Markup Conventions
* Dialogue is marked by speaker, using `<said who="">` tags, facilitating speaker-specific dialogue extraction.
* Verse is indicated by `<lg>` and `<l>` tags.
* Features such as epigraphs marked with their respective tags, e.g. `<epigraph>`.
Expand All @@ -39,7 +39,7 @@ Apart from markup features, one of the distinguishing features of this project i

See [the issue tracker](https://github.com/JonathanReeve/corpus-joyce-portrait-TEI/issues) for a more complete list.

##An Example Epigraph
## An Example Epigraph

```xml
<epigraph>
Expand All @@ -50,7 +50,7 @@ See [the issue tracker](https://github.com/JonathanReeve/corpus-joyce-portrait-T
</epigraph>
```

##An Example of language markup:
## An Example of language markup:

```xml
<p>The word now shone in his brain, clearer and brighter
Expand All @@ -62,7 +62,7 @@ examples that he had learnt in Latin had run:
<seg xml:lang="lat"><hi rend="italic">India mittit ebur</hi></seg>;
```

##How to contribute:
## How to contribute:

See [CONTRIBUTING.md](https://github.com/JonathanReeve/corpus-joyce-portrait-TEI/blob/gh-pages/CONTRIBUTING.md).

Expand Down

0 comments on commit 29cfdf8

Please sign in to comment.