Skip to content

hwennnn/SimpCity

Repository files navigation

SimpCity

Links to wiki

  1. Roadmap
  2. Daily Scrum
  3. Sprint Goal
  4. Sprint Retrospective
  5. Progress Update Report

Development guide

During development, please create a new branch feature/{featureName} from the latest development branch. When the feature is finished developed, please submit a pull request before merging the feature branch to the development branch for code reviewing.

Commit messages style

<type>: <description>

  • feat - adding feature or enhancements to the application
  • fix - bug fix
  • refactor - refactoring a specific section of the codebase
  • test - related to testing
  • docs - related to documentation
  • ci - related to continuous integration
  • cd - related to continuous delivery
  • style - Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • chore - Changes to the build process or auxiliary tools and libraries such as documentation generation

Notes: Please only specifc one type in one commit!

Pull request template

IMPORTANT: Please do not create a Pull Request without creating an issue first.

Any change needs to be discussed before proceeding. Failure to do so may result in the rejection of the pull request.

Please provide enough information so that others can review your pull request:

Explain the details for making this change. What existing problem does the pull request solve?

Test plan (required)

Demonstrate the code is solid. Example: The exact commands you ran and their output, screenshots / videos if the pull request changes UI.

Closing issues

Put Closes #XXXX in your comment to auto-close the issue that your PR fixes (if such, only put this when the issue is to be completed or else just link the issue).

Build with Docker

Run docker with -ti flag to run in interative mode

docker build -t simpcity .
docker run -ti simpcity

Run docker with production image

docker pull devops02team4/simpcity:latest
docker run -ti devops02team4/simpcity:latest

Run pytest unit testing in docker

docker build -t simpcity-test -f Dockerfile.test .

Comments Style

Used to help with generating documentation using pydoc

Functions

  """
    Summary or Description of the Function should fit in one line

    Parameters:
      argument1 (int): Description of arg1

    Returns:
      int:Returning value

   """

Classes

    """
      Summary line for a class should fit in one line.

      Attributes:
        attr1 (str): Description of `attr1`.
        attr2 (:obj:`int`, optional): Description of `attr2`.

      Properties:
        func1 (int) :  Description of func1

    """

Credits


Zachary Hong Rui Quan
(S10185319J)
Project Manager


Wai Hou Man
(S10197636F)
Tech Lead


Tee Yong Teng
(S10198102E)
QA Lead


Glenn Peh Chia Kit
(S10195629B)
Developer

About

This is the assignment for DevOps module in Ngee Ann Polytechnic

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors 4

  •  
  •  
  •  
  •  

Languages