User Tools

Site Tools


Writing /app/www/public/data/meta/onboarding/developer_dos_and_donts.meta failed
onboarding:developer_dos_and_donts

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
onboarding:developer_dos_and_donts [2020/09/29 13:12] – removed mmcconboarding:developer_dos_and_donts [2021/06/25 10:09] (current) – created - external edit 127.0.0.1
Line 1: Line 1:
 +====== Development Guide ======
 + --- //[[colm.carew@errigal.com|Colm Carew]] 2018/07/10 01:03//
  
 +===== How do we get a development Ticket =====
 +Usually you will be assigned a JIRA Ticket to work on whose naming format is usually IDMS-XXXX (IDMS-1234 for example).
 +The ticket is very important as this is what is used for time tracking, naming the your git branch and also needs to be the start of your commit messages.
 +
 +===== What are the Git Naming Conventions =====
 +When you are assigned a ticket, ensure you have the main branch version (usually dev or master) running locally - http://wiki.err/doku.php?id=onboarding:advanced:start
 +
 +Once the application is running, through Intellij, create a new branch off of the main branch with the title of your ticket and a short description i.e. IDMS-1234-demo-ticket.
 +
 +Once you have done some work on the ticket you can commit it and push it to origin (again via Intellij). Ensure your commit message follows the format of "IDMS-1234 - Description". The ticket is very important and has linking between Jira and Bitbucket.
 +
 +===== How do I merge my code to the main branch =====
 +This is gone into detail here - http://wiki.err/doku.php?id=development:bitbucket_guidelines
 +
 +For a quick summary, you need to open a pull request in the BitBucket UI. Ensure the close branch on merge checkbox is ticked and then you need to assign a reviewer to the pull request.
 +
 +Once someone approves the Pull Request you can then merge your code.
 +
 +===== How do I build my Branch =====
 +For most applications, branches should automatically start a build and keep the latest 2 builds. As of writing this the build server is - http://apate.err:8080/ and your build can be found within the application name, followed by the feature branches folder.
 +
 +It should also show on the PR whether your build passed or failed.
 +
 +This automatic building is why it is very important to close your branch after the PR has been merged, else builds will hang around on Jenkins and eventually fill the disk storage