Versions Compared

Old Version 5

changes.mady.by.user Joseph Baxter

Saved on

compared with

New Version Current

changes.mady.by.user Richard Aspden

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Setting up a Rogo development environment

  1. Fork the rogoOSS repository.
  2. Checkout the develop branch

  3. build libraries

    Code Block
    languagebash
    php composer.phar install
npm install


  4. build js/css with grunt

    Code Block
    languagebash
    grunt


  5. See Rogo Docker for instructions on how to get Rogo running on your development environment. Or if you prefer Rogo Vagrant.

Contributing to the project is simple.

  1. Create a ticket in the issue tracker. 

    Tip

    If you have not used the issue tracker before. Feel free to skip this step and just submit a pull request, one of the reviewers would be more than happy to explain how to create an issue for your future contributions.

  2. Fork the rogoOSS repository.
  3. Checkout the develop branch

    Note
    titleSecurity Issues

    When raising issues with security please remember to set the Security Level to 'Security Issue'. These tickets are only visible to the issue reporter and the University of Nottingham.


  4. Branch off your develop branch using the ticket id in the branch name i.e. hotfix/ROGO-1490
  5. Make your changes and commit to the develop branch on your repository your new branch (enter the issue tracker id into the commit message i.e. "ROGO-1490 event not defined for preventDefault").
  6. Comply with the coding standards
  7. Submit a pull request to the rogoOSS repository (develop branch).

    1. Large amounts of code are much more complicated and time consuming to review so where ever possible large changes should be split into multiple smaller logical parts

  8. After a code review your contribution will be merged into the develop branch and schedule scheduled for a release.

Once your changes have been released passed review it would be of great help if you could contribute some documentation if applicable in the  Functional Specification and/or System Documentation areas. You will need permissions to do this so plase ask for them in the issue you raised in the above steps.

 

Security Issues:

When raising issues with security please remeber to set the Secutirty Level to 'Security Issue' these tickets are only visable to the issue reporter and the University of Nottingham.

 

Developer help:

 

 

...

Translators

If you would like to contribute to translating rogo please visit our Crowdin site.