Skip to content

Repository Structure

Jump to bottom
cyber-tron edited this page Jan 17, 2013 · 2 revisions

Commit Messages

Commit messages should have the following format:

Short (50 chars or less) summary of changes
More detailed explanatory text, if necessary. Wrap it to about 72

characters or so. In some contexts, the first line is treated as the
subject of an email and the rest of the text as the body. The blank
line separating the summary from the body is critical (unless you omit
the body entirely); tools like rebase can get confused if you run the
two together.

Further paragraphs come after blank lines.
- Bullet points are okay, too
- Typically a hyphen or asterisk is used for the bullet, preceded by a
  single space, with blank lines in between, but conventions vary here

Using the branches

For developing in MassIdea, we use branches to collect functional improvements. These branches are afterwards merged into the master branch for deployment. Currently, there are the following types of branches:

  • master: Main branch for deployment. We do not commit directly into this branch but merge from development right before putting the most recent development state onto the productive system.
  • development: All development comes together in this branch for final testing on the staging system. It is also the base for all story branches.
  • story: No actual branch, rather kind of a namespace.
  • refactoring: A namespace again, used for updates and code refactoring.
    • refactoring/bootstrap: Migration of the frontend to the Twitter Bootstrap library.
    • refactoring/forms: Migration of all forms to Twitter_Form_Bootstrap_*.
  • issue: Namespace for bugfixing. Use numbers from the Github issue tracker (e.g. issue/xxx)

Folder Structure

The list below describes the meaning of every folder in the repository:

  • application: Contains all Controllers, Views and Models for the application.
  • config: The configuration folder. Please add your APPLICATION_ENV settings at the very bottom to set up database access.
  • library: Contains all third party libraries and the Oibs folder, which contains MassIdea-specific code.
  • logs: Currently unused
  • sql: Contains the database schema. When you set up your new database, first run database.sql and then every script starting with a number, starting with 05_story003_alterLanguages_lng.sql. The subfolder sql_testdata contains realistic test data.
  • tmp: Currently unused
  • www: The web server root. This folder contains all JavaScript, CSS and LESS files.

Clone this wiki locally