Developing Code

This precis assumes knowledge of GIT, Bitbucket and the repository structure of our products.

1. Usually, this involves a JIRA ticket.
   
   1. Set the ticket to in progress
   2. look at the requirements
   3. find out which product needs to be changed.
2. Check out the code.
   1. For small fixes, cloning the master branch of the GIT repository.
3. Modify the code
   1. Coding Standard for Python
4. Test
   
   1. Work out a test plan
      1. Ideally, this would include new unit tests in the tests/ folder
      2. Make sure unit tests explain what they're testing and/or reference documentation . Cucumber or similar might help here.
   2. Tox test automation files are provided in all repositories - seeing Running tox - test automation for further details
   3. Running tox will run the available test files as well as running the flake8 utility.
   4. Go to 3 until the tests are satisfied.
   5. Run a smoke test by running the larger product. It's worth doing this before the commit - see discussion in Editing, Building Validation et al
5. Commit Code
   1. Include the JIRA Ticket Number at the beginning of the message - this will link the code to the JIRA ticket in JIRA.
   2. On commit, automated build processes will take place. The build will appear here:
      
      \\rr-bamboo.northbristol.local\Registry_Test_Utils
      
      
   3. For something like Validation, if you have not already, run a smoke test.
6. Hand over for User Acceptance Test
   
   1. set the JIRA to review.