Merge pull request #583 from fredericDelaporte/ContribDocImprovement

Improvement for reducing JIRA number mismatches, and some typos fixed.

Author: fredericDelaporte

CONTRIBUTING.md

@@ -72,11 +72,11 @@ Ensure that your e-mail address and name are configured appropriately in Git.
 
 Create a feature branch so it's easy to keep it separate from other improvements. Having a pull request accepted might involve further commits based on community feedback, so having the feature branch provides a tidy place to work from. Using the issue number as the branch name is good practice. 
 
-When you commit, please include the issue number in your commit message. This will allow the JIRA issue tracker to link to automatically link your commits to the issue. For example: NH-1234 
+When you commit, please include the issue number in your commit message. This will allow the JIRA issue tracker to automatically link your commits to the issue. By example: *NH-1234 - test case for blah trouble*.  Make sure you do not put any non whitespace character adjacent to the issue number, as this would prevent JIRA to match it. (Avoid *NH-1234: test case for blah trouble*.)
 
 ## Implementing the Bug Fix or Improvement
 
-Since you now have a failing test case, it should be straight-forward to step into NHibernate to attempt to ascertain what the problem is. While this may seem daunting at first, feel free to give it a go. It's just code afterall. :) 
+Since you now have a failing test case, it should be straight-forward to step into NHibernate to attempt to ascertain what the problem is. While this may seem daunting at first, feel free to give it a go. It's just code after all. :) 
 
 ### Ensure All Tests Pass
 
@@ -88,7 +88,7 @@ Please note that some tests assume a case insensitive accent sensitive database
 
 Be sure to link to the JIRA issue in your GitHub pull request. Also, go back to your JIRA issue and link to the pull request. 
 
-We use tabs for code indentation, not spaces. As this is not the default in Visual Studio, you will need to reconfigure Visual Studio to indent with tabs whenever you work on the NHibernate codebase. To make this easier, NHibernate has an [editorconfig][3] configuration file to switch Visual Studio automatically between tabs and spaces mode. It is recomended you install editorconfig from the Visual Studio Extension Manager.
+We use tabs for code indentation, not spaces. As this is not the default in Visual Studio, you will need to reconfigure Visual Studio to indent with tabs whenever you work on the NHibernate codebase. To make this easier, NHibernate has an [editorconfig][3] configuration file to switch Visual Studio automatically between tabs and spaces mode. It is recommended you install editorconfig from the Visual Studio Extension Manager.
 
 ## Further Discussion
 

Contributor Guide.html

@@ -124,12 +124,12 @@ <h2>Commit your Test Case</h2>
 </p>
 
 <p>
-When you commit, please include the issue number in your commit message.  This will allow the JIRA issue tracker to link to automatically link your commits to the issue.  For example: NH-1234
+When you commit, please include the issue number in your commit message.  This will allow the JIRA issue tracker to automatically link your commits to the issue.  By example: <i>NH-1234 - test case for blah trouble</i>.  Make sure you do not put any non whitespace character adjacent to the issue number, as this would prevent JIRA to match it. (Avoid <i>NH-1234: test case for blah trouble</i>.)
 </p>
 
 <h2>Implementing the Bug Fix or Improvement</h2>
 
-Since you now have a failing test case, it should be straight-forward to step into NHibernate to attempt to ascertain what the problem is.  While this may seem daunting at first, feel free to give it a go.  It's just code afterall. :)
+Since you now have a failing test case, it should be straight-forward to step into NHibernate to attempt to ascertain what the problem is.  While this may seem daunting at first, feel free to give it a go.  It's just code after all. :)
 
 <h3>Ensure All Tests Pass</h3>
 <p>
@@ -146,7 +146,7 @@ <h2>Submit a Pull Request</h2>
 </p>
 <p>We use tabs for code indentation, not spaces. As this is not the default in Visual Studio, you will need to reconfigure Visual Studio to indent with tabs whenever you work on the NHibernate codebase. To make this easier, NHibernate has an 
     <a href="http://www.editorconfig.org/">editorconfig</a> configuration file to switch Visual Studio automatically between
-tabs and spaces mode. It is recomended you install editorconfig from the Visual Studio Extension Manager.</p>
+tabs and spaces mode. It is recommended you install editorconfig from the Visual Studio Extension Manager.</p>
 
 <h2>Further Discussion</h2>