From e9c76e82c4b160b56df69c4bb4398cdf000a8dc9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Br=C3=B6tzmann?= Date: Wed, 29 Apr 2020 21:58:58 +0200 Subject: [PATCH] Update CONTRIBUTING and README for Gajim 1.2 --- CONTRIBUTING.md | 16 +++++++++------- README.md | 26 ++++++++++++++------------ 2 files changed, 23 insertions(+), 19 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0d1ddac..4077f96 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,17 +1,19 @@ -### Branches +# Contributing + +## Branches - master +- gajim_1.2 - gajim_1.1 - gajim_1.0 - gajim_0.16 -### Git +## Git -If you are not familiar with Git please read the [HowTo](https://dev.gajim.org/gajim/gajim/wikis/howtogit) +If you are not familiar with Git, please read the [HowTo](https://dev.gajim.org/gajim/gajim/wikis/howtogit) ### Git Commit Messages -* Start your commit message with the Plugin name, example: [omemo] Added .. -* Use the present tense ("Add feature" not "Added feature") -* Limit the first line to 50 characters or less, add whatever you feel necessary -in the extended commit message +- Start your commit message with the Plugin name, example: [omemo] Added .. +- Use the present tense ("Add feature" not "Added feature") +- Limit the first line to 50 characters or less, add whatever you feel is necessary in the extended commit message diff --git a/README.md b/README.md index b452e2b..d5b0402 100644 --- a/README.md +++ b/README.md @@ -1,47 +1,49 @@ -## Welcome to the Gajim Plugins Wiki - -In this place you find all plugins that are written for Gajim by the community. If you experience any problems with those plugins, please report them here. +# Gajim Plugins + +In this place you will find all plugins that are written for [Gajim](https://gajim.org) by the community. If you experience any problems with those plugins, please report them here. ## How to install plugins There are several ways to install a plugin: - - You can browse / download / enable / configure plugins from within Gajim via 'Gajim' > 'Plugins' menu. - - You can also clone the repository directly from our Git and copy it to: +- You can browse / download / enable / configure plugins from within Gajim via 'Gajim' > 'Plugins' menu. +- You can also clone the repository directly from our Git and copy it to: **Linux:** `~/.local/share/gajim/plugins/` **Windows:** `C:\Users\USERNAME\AppData\Roaming\Gajim\Plugins` - - Alternatively (for developing), you can also symlink the gajim-plugins repository to Gajim's plugin path - +- Alternatively (for developing), you can also symlink the gajim-plugins repository to Gajim's plugin path: + **Symlink:** `ln -s /path/to/gajim-plugins-repository/* ~/.local/share/gajim/plugins/` **For each major Gajim version there is a different plugins branch:** | Version | Plugins branch | | ------- | -------------- | -|Gajim 1.0|[1.0 branch](https://dev.gajim.org/gajim/gajim-plugins/tree/gajim_1.0)| -|Gajim 1.1|[1.1 branch](https://dev.gajim.org/gajim/gajim-plugins/tree/gajim_1.1)| |Gajim master|[master branch](https://dev.gajim.org/gajim/gajim-plugins/tree/master)| +|Gajim 1.2|[1.2 branch](https://dev.gajim.org/gajim/gajim-plugins/tree/gajim_1.2)| +|Gajim 1.1|[1.1 branch](https://dev.gajim.org/gajim/gajim-plugins/tree/gajim_1.1)| +|Gajim 1.1|[1.1 branch](https://dev.gajim.org/gajim/gajim-plugins/tree/gajim_1.1)| +|Gajim 1.0|[1.0 branch](https://dev.gajim.org/gajim/gajim-plugins/tree/gajim_1.0)| *Note: Using master branch for plugins requires frequent updates of both Gajim and plugins!* ## Share / improve Plugins -You have written a new plugin or want to improve an already existing one? +You have written a new plugin or want to improve an existing one? First, thanks for that! Here is how to start: - Register an account on our Gitlab [here](https://dev.gajim.org/users/sign_in) - Tell us about your plans at [gajim@conference.gajim.org](xmpp:gajim@conference.gajim.org?join) - Fork the Gajim-Plugins [repository](https://dev.gajim.org/gajim/gajim-plugins) -- When you are finished, make a pull request against the main repository. You can read about how to use git [here](https://dev.gajim.org/gajim/gajim/wikis/howtogit). +- When you are finished, do a merge request against the main plugins repository. You can read about how to use git [here](https://dev.gajim.org/gajim/gajim/wikis/howtogit). - Additionally, there is a list of [plugin events](https://dev.gajim.org/gajim/gajim/wikis/development/pluginsevents) which might be helpful **Before you put in any work, please contact us on [gajim@conference.gajim.org](xmpp:gajim@conference.gajim.org?join)** -**Don't use dev.gajim.org for any projects that are not directly for the benefit of Gajim** +**Please do not use dev.gajim.org for any projects that are not directly for the benefit of Gajim!** ## Plugins list