mirror of https://github.com/nextcloud/calendar
Georg Ehrke
parent
3268608c2c
commit
6f932d1196
69
README.md
69
README.md
|
|
@ -1,29 +1,62 @@
|
|||
README
|
||||
======
|
||||
|
||||
[](https://scrutinizer-ci.com/g/owncloud/calendar/build-status/rework) [](https://scrutinizer-ci.com/g/owncloud/calendar/?branch=rework) [](https://scrutinizer-ci.com/g/owncloud/calendar/?branch=rework)
|
||||
[](https://scrutinizer-ci.com/g/owncloud/calendar-rework/build-status/master)[](https://scrutinizer-ci.com/g/owncloud/calendar-rework/?branch=master)[](https://scrutinizer-ci.com/g/owncloud/calendar-rework/?branch=master)
|
||||
|
||||
This is the calendar rework branch. <br>
|
||||
It will replace the old calendar code with ownCloud 8 or ownCloud 9. <br>
|
||||
It's still __in development__, __don't use it in a productive environment__. <br>
|
||||
There will be legacy apis, but you should consider implementing new features based on this branch and not based on current master.
|
||||
|
||||
### Building JavaScript
|
||||
Make sure you have node and npm installed on your development machine in order to run the JavaScript tasks.
|
||||
All commands should be run inside the build directory
|
||||
This is the rework of the calendar app. <br>
|
||||
It will replace the [old calendar app](https://github.com/owncloud/calendar) with ownCloud 9.0.
|
||||
|
||||
**Updating 3rdparty files**
|
||||
We use bower to manage 3rdparty dependancies in ownCloud calendar. In order to install bower, run,
|
||||
> npm install -g bower
|
||||
It's __in development__, don't use it in production.
|
||||
|
||||
To run the build tasks, we use gruntjs tasks which can be installed via npm as
|
||||
> npm install
|
||||
### Maintainers:
|
||||
|
||||
Building SASS and JS
|
||||
> grunt build
|
||||
- [Georg Ehrke](https://github.com/georgehrke)
|
||||
- [Raghu Nayyar](https://github.com/raghunayyar)
|
||||
- [Bernhard Fröhler](https://github.com/codeling)
|
||||
|
||||
Watching SASS and JS
|
||||
> grunt watch
|
||||
### Joining Development
|
||||
|
||||
Coming Soon: running JS tests.
|
||||
#### 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](https://doc.owncloud.org/server/8.1/developer_manual/app/index.html) to get a rough idea of how stuff works.
|
||||
Please take a close look at the [coding style guidelines](https://doc.owncloud.org/server/8.1/developer_manual/general/codingguidelines.html) 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 git@github.com: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](https://docs.npmjs.com/getting-started/installing-node) installed on your development machine.
|
||||
|
||||
Simply run the following commands to setup your development environment:
|
||||
|
||||
```bash
|
||||
# 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](https://raw.githubusercontent.com/owncloud/core/master/issue_template.md)__, __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.
|
||||
|
|
|
|||
Loading…
Reference in New Issue