amin-hedayati / calendar-rework

Rework of the ownCloud calendar app (#owncloud-calendar)

README

This is the rework of the calendar app.
It will replace the old calendar app with ownCloud 9.0.

It's in development, don't use it in production.

Maintainers:

• Georg Ehrke
• Raghu Nayyar
• Bernhard Fröhler

Joining Development

Contributing code

You are a JS or a PHP dev and want to help with the development?

Thanks for wanting to contribute source code to the ownCloud calendar. That's great!

Before you start, we would like to ask you to take a look at the development manual to get a rough idea of how stuff works. Please take a close look at the coding style guidelines as well.

Getting the source code

An app-folder's name must always equal the appid. Be sure the folder is called calendar.

git clone [email protected]:owncloud/calendar-rework.git calendar

Contributing code

Please don't push directly into master. We would rather ask you to send pull requests.

In order to constantly increase the quality of our software we can no longer accept pull request which submit un-tested code. It is a must have that changed and added code segments are unit tested.

Building JavaScript

In order to modify our javascript, you need to install a few tools. Please make sure you have node and npm installed on your development machine.

Simply run the following commands to setup your development environment:

# Install bower for mananing 3rdparty js libs
npm install -g bower

# Install build dependecies
npm install

You have two options for building the javascript code. You can either make your changes and run grunt build afterwords or you can start grunt watch, which will regenerate the js/public/app.js on every save of a file.

Testing

You don't know how to code, but want to contribute anyway?

You sure can help us!

Testing is a crucial part of developing software. You can help us by testing the calendar app and providing high-quality bug reports. Please always use the issue template, fill out everything and be as precise as possible. Always make sure that you are running the latest version. Search for existing issues before creating new ones, having to deal with duplicate bug reports is a big waste of time for us.