Difference between revisions of "Custom development requirements"

From Kolmisoft Wiki
Jump to navigationJump to search
m
Line 16: Line 16:
* All code and documentation has to be compresses into 1 archive, *.zip or *.tar.gz are preferred.
* All code and documentation has to be compresses into 1 archive, *.zip or *.tar.gz are preferred.
* When you have your feature developed - create a ticket for it in our [[Create_new_Ticket_in_Ticket_System|support system]] and attach your compressed archive with all information there as attachment.
* When you have your feature developed - create a ticket for it in our [[Create_new_Ticket_in_Ticket_System|support system]] and attach your compressed archive with all information there as attachment.
== Custom development tips==
===Assets===
Starting from MOR X3 - Rails assets are used to serve static content faster. This benefit comes with greater complexity.
====Images====
When you add static images, let's say icons - put them in this directory:
/home/mor/app/assets/images/
Dynamic images (those that can be upload by user from MOR GUI, for example company logo, calling cards image, etc..):
/home/mor/public/images/
====JavaScript====
All new JavaScript files must be put here:
/home/mor/vendor/assets/javascripts/
All new JavaScript files must be included in:
/home/mor/app/assets/javascripts/application.js
but 1 line upper than the last line.

Revision as of 13:18, 5 April 2013

This page is under development!

About

These are the requirements in order your custom developed features would be integrated into main code base.

Legal requirements

In order we would add your custom developed features or bugfixes into our main code base - you must sign an agreement and send it us via email: b2bsales@kolmisoft.com. Agreement can be downloaded here.

Other requirements

  • The code must follow best practices defined here.
  • The code must be well documented - every method must contain documentation what is does.
  • The code (the whole directory /home/mor) must be compressed into archive:
tar czf mor_custom.tar.gz /home/mor
  • The code must come with documentation in Microsoft Word/OpenOffice ir PDF format what developed feature does.
  • All code and documentation has to be compresses into 1 archive, *.zip or *.tar.gz are preferred.
  • When you have your feature developed - create a ticket for it in our support system and attach your compressed archive with all information there as attachment.


Custom development tips

Assets

Starting from MOR X3 - Rails assets are used to serve static content faster. This benefit comes with greater complexity.

Images

When you add static images, let's say icons - put them in this directory:

/home/mor/app/assets/images/

Dynamic images (those that can be upload by user from MOR GUI, for example company logo, calling cards image, etc..):

/home/mor/public/images/

JavaScript

All new JavaScript files must be put here:

/home/mor/vendor/assets/javascripts/

All new JavaScript files must be included in:

/home/mor/app/assets/javascripts/application.js

but 1 line upper than the last line.