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.
<type>: <description>
feat
- adding feature or enhancements to the applicationfix
- bug fixrefactor
- refactoring a specific section of the codebasetest
- related to testingdocs
- related to documentationci
- related to continuous integrationcd
- related to continuous deliverystyle
- 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!
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?
Demonstrate the code is solid. Example: The exact commands you ran and their output, screenshots / videos if the pull request changes UI.
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).
docker build -t simpcity .
docker run -ti simpcity
docker pull devops02team4/simpcity:latest
docker run -ti devops02team4/simpcity:latest
docker build -t simpcity-test -f Dockerfile.test .
Used to help with generating documentation using pydoc
"""
Summary or Description of the Function should fit in one line
Parameters:
argument1 (int): Description of arg1
Returns:
int:Returning value
"""
"""
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
"""
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 |