Commits

abudden  committed 1e9507d

Added more documentation on how to contribute to TagHighlight.

  • Participants
  • Parent commits e6145ad

Comments (0)

Files changed (1)

File doc/TagHighlight.txt

 	4.1   Adding More Languages              |TagHighlight-adding|
 	4.1.1 Example                            |TagHighlight-add-example|
 
-	5.    Troubleshooting                    |TagHighlight-troubleshooting|
+	5.    Contributing Changes               |TagHighlight-contributions|
+	5.1   Suggestions for Improvements       |TagHighlight-suggestions|
+	5.2   Patches                            |TagHighlight-patches|
+	5.3   Usage Examples                     |TagHighlight-usage-examples|
 
-	6.    TagHighlight History               |TagHighlight-history|
+	6.    Troubleshooting                    |TagHighlight-troubleshooting|
+
+	7.    TagHighlight History               |TagHighlight-history|
 
 ==============================================================================
 2. TagHighlight Manual           *TagHighlight-manual*                      {{{1
 	It really is that easy!
 
 ==============================================================================
-5. Troubleshooting                       *TagHighlight-troubleshooting*     {{{1
+5. Contributing Changes                  *TagHighlight-contributions*       {{{1
+
+	Contributions to TagHighlight are, of course, very welcome.  The bug
+	tracker is currently private (due to it running on my home server behind a
+	firewall) and this is unlikely to change in the near future.  However, the
+	code is public and I am happy to accept, patches or suggestions for
+	improvements and usage examples.
+
+5.1 Suggestions for Improvements         *TagHighlight-suggestions*         {{{2
+
+	For suggestions for improvements, please send me an email to:
+>
+		abudden _AT_ gmail.com
+<
+	Please include as much detail as possible.
+
+5.2 Patches                              *TagHighlight-patches*             {{{2
+
+	If you've made an improvement to TagHighlight and would like your changes
+	to be included in the main distribution, there are a number of ways of
+	doing this.  The code is maintained in a Mercurial repository and
+	published on bitbucket.  There is also a github mirror if you really
+	prefer.  In rough order of preference, the ways you can send me a patch
+	are:
+
+		1. Bitbucket pull request (https://bitbucket.org/abudden/easycolour)
+
+		2. Mercurial bundle (see "hg help bundle") attached to an email.
+
+		3. Mercurial patchbomb email (for details of the patchbomb extension,
+		please see http://mercurial.selenic.com/wiki/PatchbombExtension).
+
+		4. Github pull request (https://github.com/abudden/EasyColour).
+
+	If sending a patch, please follow these guidelines:
+
+	* Could should conform to the same general coding standard as the existing
+	  source tree.  This isn't especially strict or well documented, but at
+	  the very least python code should be indented with four spaces and
+	  everything else should be indented with hard tabs but alignment should
+	  be with spaces.  As a general guide, '^\t\+' is good but either '\S\t'
+	  or '^\s\+' is bad (there are exceptions).
+
+	* Please help to maintain the documentation at the same time, including:
+
+		- The history in |TagHighlight-history|: if there isn't an entry there
+		  for an unreleased version, pease add one, something like:
+>
+			x.x.x: xxth Xxxxxxxx 2012  : Added support for LANGUAGE.
+<
+		  (leave the x characters in, I'll change these when I release the
+		  next version).
+
+		- Any options that have been added: add these both to the categorised
+		  |TagHighlight-option-list| and the alphabetic (and more detailed)
+		  |TagHighlight-option-summary|.
+
+5.3 Usage Examples                       *TagHighlight-usage-examples*      {{{2
+
+	There is a wiki available at:
+>
+		https://bitbucket.org/abudden/taghighlight/wiki/Home
+<
+	Please feel free to add usage examples to this page.
+
+==============================================================================
+6. Troubleshooting                       *TagHighlight-troubleshooting*     {{{1
 
 	A debugging log can be generated by running the command:
 >
 <
 
 ==============================================================================
-6. TagHighlight History                *TagHighlight-history*               {{{1
+7. TagHighlight History                *TagHighlight-history*               {{{1
 
 x.x.x: xxth Xxxxxxxx 2012  : Fixed globpath to prevent use of wildignore
                              option (thanks to Vincent).  Added support for