[geany/geany-plugins] 3ea563: HACKING: Added info about MAINTAINERS and po/POTFILES.in

Frank Lanitz git-noreply at xxxxx
Mon Apr 15 14:17:28 UTC 2013


Branch:      refs/heads/master
Author:      Frank Lanitz <frank at frank.uvena.de>
Committer:   Frank Lanitz <frank at frank.uvena.de>
Date:        Mon, 15 Apr 2013 14:17:28 UTC
Commit:      3ea5639b70626894e38f51aae104186501f5921d
             https://github.com/geany/geany-plugins/commit/3ea5639b70626894e38f51aae104186501f5921d

Log Message:
-----------
HACKING: Added info about MAINTAINERS and po/POTFILES.in


Modified Paths:
--------------
    HACKING

Modified: HACKING
40 files changed, 40 insertions(+), 0 deletions(-)
===================================================================
@@ -141,6 +141,7 @@ Example::
     This avoid spawning an unexpected browser when the configured one is
     wrong, and gives the user a chance to correctly fix the preference.
 
+
 Coding and Plugin structure
 ===========================
 
@@ -235,7 +236,46 @@ informationen how to build the sources. An example could look like::
 
     include $(top_srcdir)/build/cppcheck.mk
 
+Additional things to do for a new plugin
+----------------------------------------
+
+Adding yourself to MAINTAINERS
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+As you might want to keep on maintaining your newly added plugin, we 
+recommend to put your contact data to file MAINTAINERS which is 
+located inside geany-plugins root folder. The entry should contain 
+your plugin name as well as some of the important data. An example 
+could look like::
+
+	myfancyplugin
+	P: Jon Doe <jon at example.org>
+	M: Jon Doe <jon at example.org>
+	W: http://example.org/myfancyplugin 
+	S: Maintained
+
+The flags can be compiled like this: 
+
+* P: Person
+* M: Mail patches to: FullName <address at domain>
+* W: Web-page with status/info
+* S: Status of plugin
+
+Once you have a look onto MAINTAINERS you will see a lot of examples 
+as well as some more detailed information.
+
+
+Adding your plugin-files to po/POTFILES.in
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
+If you want to have your plugin translated into different languages 
+you will have to add your plugin to file po/POTFILES.in. This 
+contains a list of all translateable files for each plugin. An 
+example could look like::
+	
+	#myfancyplugin
+	yourfancypluginname/src/yourfancypluginname.c
+	
 
 I18n/l10n
 ---------



--------------
This E-Mail was brought to you by github_commit_mail.py (Source: https://github.com/geany/infrastructure).


More information about the Plugins-Commits mailing list