From a70edade661a44c596fa51b97a484eba521cdf81 Mon Sep 17 00:00:00 2001 From: Pierrick Le Gall Date: Sat, 29 Apr 2023 17:32:24 +0200 Subject: [PATCH] copy from DokuWiki --- ...-source-code-manager-for-your-extension.md | 69 +++++++++++++++++++ 1 file changed, 69 insertions(+) create mode 100644 Use-a-source-code-manager-for-your-extension.md diff --git a/Use-a-source-code-manager-for-your-extension.md b/Use-a-source-code-manager-for-your-extension.md new file mode 100644 index 0000000..6a552f9 --- /dev/null +++ b/Use-a-source-code-manager-for-your-extension.md @@ -0,0 +1,69 @@ +# Use a source code manager (SCM) + +It is highly recommended to use a SCM when you create and maintain a +plugin. Piwigo.org extensions manager and translation manager are both +compatible with Subversion (SVN) and Github. Piwigo.org also provides an +SVN repository where your extension is welcomed. + +## PEM (plugins repository) + +#### Configure your Git or SVN repository + +Go to [your page](http://piwigo.org/ext/my.php) and select your plugin, +then click on the SCM icon +![](http://piwigo.org/ext/template/images/scm.png). + +Select Git or SVN and change the URL, don't change the other fields. You +must give the root URL of your repo: + +- example on Github `https://github.com/Piwigo/ContactForm` +- example on Piwigo.org SVN + `http://piwigo.org/svn/extensions/ContactForm` + +Validate. You should see the correct Github/SVN information in the +bottom block, if not, double check the form. + +#### Release a new revision from your SCM + +When you release a new revision of your extension, you can let PEM do it +directly from your SCM. PEM will automatically extract files, add +release info, replace the version number in your source code. PEM can +also detect the new languages! + +If you use Git, you will be able to choose a specific branch. If you use +SVN, you will be able to choose a specific SVN revision. + +## Lexiglot (translation platform) + +If you want to benefit from the work of the active Piwigo translation +team, your plugin can be added in [Piwigo +Translate](http://piwigo.org/translate). You can simply ask us on +[Contact page](http://piwigo.org/contact) or we may directly contact you +about your plugin! + +If your plugin is using Piwigo.org SVN, we manage the commit access. If +you're on Github, here is what you have to do: + +#### Authorize user + +As on SVN we use a single user to push translations to all plugins, this +user is +[Piwigo-TranslationTeam](https://github.com/Piwigo-TranslationTeam). You +must give push access to the user on your repo. + +To do so, on your repository page, go to **Settings / Collaborators** +and add **Piwigo-TranslationTeam**. + +#### Notify us + +We need to configure Lexiglot to use your Github repository. Contact us +on [Contact page](http://piwigo.org/contact) to tell us what is the +location of your plugin. + +By default all commits are pushed to the `master` branch, you can tell +us if you want translations to be pushed to any other branch (the branch +must already exists). + +We decided to not use pull-requests because it's a bit more complicated +to implement and we don't want to spam you with a bunch of PR every week +(the translation team is very active !). \ No newline at end of file