hueso/gajim-plugins
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update CONTRIBUTING and README for Gajim 1.2

Browse Source
This commit is contained in:
Daniel Brötzmann
2020-04-29 21:58:58 +02:00
parent b372c5a699
commit e9c76e82c4
2 changed files with 23 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
CONTRIBUTING.md
View File

@@ -1,17 +1,19 @@
### Branches # Contributing
## Branches
- master - master
- gajim_1.2
- gajim_1.1 - gajim_1.1
- gajim_1.0 - gajim_1.0
- gajim_0.16 - 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 ### Git Commit Messages
* Start your commit message with the Plugin name, example: [omemo] Added .. - Start your commit message with the Plugin name, example: [omemo] Added ..
* Use the present tense ("Add feature" not "Added feature") - Use the present tense ("Add feature" not "Added feature")
* Limit the first line to 50 characters or less, add whatever you feel necessary - Limit the first line to 50 characters or less, add whatever you feel is necessary in the extended commit message
in the extended commit message

26
README.md
View File

@@ -1,47 +1,49 @@
## Welcome to the Gajim Plugins Wiki # Gajim Plugins
In this place you find all plugins that are written for <a href="https://gajim.org">Gajim</a> by the community. If you experience any problems with those plugins, please report them here. 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 ## How to install plugins
There are several ways to install a plugin: There are several ways to install a plugin:
- You can browse / download / enable / configure plugins from within Gajim via 'Gajim' > 'Plugins' menu. - 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 also clone the repository directly from our Git and copy it to:
**Linux:** `~/.local/share/gajim/plugins/` **Linux:** `~/.local/share/gajim/plugins/`
**Windows:** `C:\Users\USERNAME\AppData\Roaming\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/` **Symlink:** `ln -s /path/to/gajim-plugins-repository/* ~/.local/share/gajim/plugins/`
**For each major Gajim version there is a different plugins branch:** **For each major Gajim version there is a different plugins branch:**
| Version | 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 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!* *Note: Using master branch for plugins requires frequent updates of both Gajim and plugins!*
## Share / improve 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: First, thanks for that! Here is how to start:
- Register an account on our Gitlab [here](https://dev.gajim.org/users/sign_in) - 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) - 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) - 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 - 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)** **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 ## Plugins list