frodovdr/kopano-ol-extension
1
0
Fork 0
mirror of https://github.com/Kopano-dev/kopano-ol-extension.git synced 2023-10-10 13:37:40 +02:00
Code Issues Releases Wiki Activity

enhace readme, add contributing file

Browse Source
This commit is contained in:
Felix Bartels 2017-01-17 09:33:22 +01:00
parent 5ab65e8935
commit 79257ea42b
2 changed files with 58 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,33 @@
# How to contribute to Kopano Core
While you can create an account in our [Jira](
https://jira.kopano.io/secure/Signup!default.jspa) to get notified about
the progress of tickets, we currently do not allow external users to
create issues or pull request against our repositories.
If you have found an issue and want to create an issue please either reach
out to us in our [forum](http://forum.kopano.com), or if you have a
subscription open up a [support case](https://kopano.com/support/).
To provide a patch please use the following workflow:
- Clone the individual repository from https://stash.kopano.io/
- Apply your changes to your local checkout and please include *"Released
under the Affero GNU General Public License (AGPL) version 3."* in your
commit message, so that we can safely reuse your changes.
- create a patchfile from your commits. (
https://ariejan.net/2009/10/26/how-to-create-and-apply-a-patch-with-git/
does a nice job explaining the details.)
- send the patch to
[contributing@kopano.io](mailto:contributing@kopano.io) and we'll create
an issue and a pull request for you.
## Additional notes
- Please only work on one issue per patch.
- If your patch consists of multiple commits stash them into one before
creating the patch.
- A patch should usually not change more than 50 lines of code (keep your
changes small).
- Before implementing a new feature get in contact with us so we can
determine the impact.

26
README.md
View File

@ -1,3 +1,27 @@
# Kopano OL Extension
We live in a world where it is a commodity to work with apps or web interfaces – just have a look at the big amounts of HTML5-apps on your tablets and smartphones. However, there are situations in which a rich application is needed. Think about working offline during a five hour flight or deeper integrations like writing series of letters in your Office suite.
https://stash.kopano.io/projects/KOE/repos/kopano_ol_extension_source/
This is exactly why we developed the Kopano Outlook Extension (KOE). If you are on the road a lot and thus without an internet connection, or if you rely heavily on specialised plugins in Outlook, then the Kopano OL Extension might just be the thing for you.
# Documentation
In-depth documentation, such as administration and user manuals, about our
products be be found on our [Documentation Portal](https://documentation.kopano.io/). Additionally a [Knowledge Base](https://kb.kopano.io/) is available for quick start guides, handy code
snippets, and troubleshooting help.
# Contributing
The main development of Kopano Core takes place in a [private Bitbucket
instance](https://stash.kopano.io/projects/KOE/repos/kopano_ol_extension_source/)
with development tickets organised in [Jira](https://jira.kopano.io/projects/KC/). Please see
[CONTRIBUTING.md](CONTRIBUTING.md) for steps on how to contribute patches.
# Downloading compiled packages
Compiled packages are only available to subscription
holders from the the [Kopano Portal](https://portal.kopano.com/) and a
[package repository](
https://download.kopano.io/supported/olextension:/).
# Support
Community Support is available through the [Kopano Forum](
https://forum.kopano.io/) and through the #Kopano channel on Freenode IRC
network. [Additional support options](https://kopano.com/support/) are
available for subscription holders.