Skip to content
This repository
Browse code

Minor cleanup of committing documentation

  • Loading branch information...
commit 5bbcdc1a02e21de8e9aef55e26c64e2ebc3b44b1 1 parent f9302ed
Cody Allen ceedubs authored

Showing 1 changed file with 5 additions and 5 deletions. Show diff stats Hide diff stats

  1. +5 5 CONTRIBUTING.markdown
10 CONTRIBUTING.markdown
Source Rendered
@@ -5,7 +5,7 @@ Scalatra is an open source project and it would be nice to attract many develope
5 5 If you have a problem but do not have the time or will to dive into the source code, please report it anyway
6 6 on [the github issue tracker](https://github.com/scalatra/scalatra/issues), this will allow other developers to keep an eye on it.
7 7
8   -If you can create a test case then your issue is more likely to be resolved quicker, and your test can be added to our
  8 +If you can create a test case then your issue is likely to be resolved more quickly, and your test can be added to our
9 9 suite so it is not recreated later.
10 10
11 11 When reporting an issue please try to give us all the info you have: scalatra version, operating system, scala version, sbt version,
@@ -22,11 +22,11 @@ There is no change too little to be merged in.
22 22
23 23 ### Working with Github
24 24
25   - 1. If you are not a github user, check [their page help page](http://help.github.com/) on how to get started, register and go to step 2
  25 + 1. If you are not a github user, check out [their help page](http://help.github.com/) on how to get started, register and go to step 2
26 26 2. fork us as decribed [here](http://help.github.com/forking/)
27 27 3. hack hack hack
28 28 4. push to your own forked repository
29   - 5. send a "pull request"
  29 + 5. send a [pull request](https://help.github.com/articles/using-pull-requests)
30 30
31 31 ### Become a committer
32 32 Do some good contributions and we'll give you a shiny commit bit!
@@ -35,10 +35,10 @@ Do some good contributions and we'll give you a shiny commit bit!
35 35 Good documentation is core to a succesfull and healthy ecosystem, the more we can have, the merrier.
36 36
37 37 ### Scaladoc
38   -Scaladoc lives inside the scala spource code, if you want to contribute scaladoc patches, do the same thing described above:
  38 +Scaladoc lives inside the scala source code, if you want to contribute scaladoc patches, do the same thing described above:
39 39 fork [the github project](https://github.com/scalatra/scalatra/) and write the documentation, then do a pull request.
40 40
41   -The scaladoc syntax is a mix of javadoc and wiki-like and is described at http://lampsvn.epfl.ch/trac/scala/wiki/Scaladoc/AuthorDocs
  41 +The [scaladoc syntax](http://lampsvn.epfl.ch/trac/scala/wiki/Scaladoc/AuthorDocs) is a mix of javadoc and wiki.
42 42 Rules for good code documentation are the same as in any other language/framework: why is better than what, compare
43 43
44 44 /**

0 comments on commit 5bbcdc1

Please sign in to comment.
Something went wrong with that request. Please try again.