Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

subhead format consistency, sentence casing on contributing

  • Loading branch information...
commit 18e163177b9e8debeda4dd9632452719dc77346a 1 parent f4683d8
Soon Van authored

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

  1. 28  guide/userguide/contributing.md
28  guide/userguide/contributing.md
Source Rendered
@@ -16,7 +16,7 @@ To quickly point out something that needs improvement, report a [bug report](htt
16 16
 
17 17
 If you want to contribute some changes, you can do so right from your browser without even knowing git!
18 18
 
19  
-First create an account on [Github](https://github.com/signup/free).
  19
+First create an account on [GitHub](https://github.com/signup/free).
20 20
 
21 21
 You will need to fork the module for the area you want to improve.  For example, to improve the [ORM documentation](../orm) fork <http://github.com/kohana/orm>.  To improve the [Kohana documentation](../kohana), fork <http://github.com/kohana/core>, etc.  So, find the module you want to improve and click on the Fork button in the top right.
22 22
 
@@ -34,26 +34,30 @@ After you have made your changes, send a pull request so your improvements can b
34 34
 
35 35
 Once your pull request has been accepted, you can delete your repository if you want.  Your commit will have been copied to the official branch.
36 36
 
37  
-## If you know git
  37
+## If you know Git
38 38
 
39  
-**Short version**: Fork the module whose docs you wish to improve (e.g. `git://github.com/kohana/orm.git` or `git://github.com/kohana/core.git`), checkout the `3.2/develop` branch (for the 3.2 docs!), make changes, and then send a pull request.
  39
+### Short version
40 40
 
41  
-**Long version:**  (This still assumes you at least know your way around git, especially how submodules work.)
  41
+Fork the module whose docs you wish to improve (e.g. `git://github.com/kohana/orm.git` or `git://github.com/kohana/core.git`), checkout the `3.2/develop` branch (for the 3.2 docs), make changes, and then send a pull request.
42 42
 
43  
- 1. Fork the specific repo you want to contribute to on github. (For example go to http://github.com/kohana/core and click the fork button.)
  43
+### Long version
  44
+
  45
+(This still assumes you at least know your way around Git, especially how submodules work.)
  46
+
  47
+ 1. Fork the specific repo you want to contribute to on GitHub. (For example, go to http://github.com/kohana/core and click the fork button.)
44 48
 
45 49
  1. Now you need to add your fork as a "git remote" to your application and ensure you are on the right branch. An example for the [ORM](../orm) module and 3.2 docs:
46  
-	
  50
+
47 51
 		cd my-kohana-app/modules/orm
48 52
 
49 53
 		# add your repository as a new remote
50 54
 		git remote add <your name> git://github.com/<your name>/orm.git
51  
-		
  55
+
52 56
 		# Get the correct branch
53 57
 		git checkout 3.2/develop
54  
-		
  58
+
55 59
  1. Now go into the repo of the area of docs you want to contribute to and add your forked repo as a new remote, and push to it.
56  
- 
  60
+
57 61
 		cd my-kohana-app/modules/orm
58 62
 
59 63
 		# Make some changes to the docs
@@ -61,11 +65,11 @@ Once your pull request has been accepted, you can delete your repository if you
61 65
 
62 66
 		# Commit your changes - Use a descriptive commit message! If there is a redmine ticket for the changes you are making include "Fixes #XXXXX" in the commit message so its tracked.
63 67
 		git commit -a -m "Corrected a typo in the ORM docs. Fixes #12345."
64  
-		
  68
+
65 69
 		# make sure we are up to date with the latest changes
66 70
 		git merge origin/3.2/develop
67 71
 
68  
-		# Now push your changes to your fork.		
  72
+		# Now push your changes to your fork.
69 73
 		git push <your name> 3.2/develop
70 74
 
71  
- 1. Finally, Send a pull request on github.
  75
+ 1. Finally, send a pull request on GitHub.

0 notes on commit 18e1631

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