A short description of the project
- 1 Github WorkFlow
- 2 Code Guidelines
- 3 Conceptual Architecture
- 4 Technical Architecture
- 5 Technologies
- 6 Manual
We use a modified version of Gitflow:
v-{major}-{minor}
major
for new featuresminor
for hotfixes
- Create new branch
feature/{short-description}
usingdevelop
as base - Work on it normally
- Open pull request to
develop
when done - Merge it to
develop
- Open pull request from
develop
tomaster
when doing a new release - Merge it to
master
- Tag it as appropriate using the versioning scheme (increase the major version by one and reset the minor version to zero)
- Create new branch
hotfix/{short-description}
usingmaster
as base - Work on it normally - hotfixes should be extremely small
- Open pull request when is done
- Merge it to
master
- Tag it as appropriate using the versioning scheme (keep same major, increase minor version by one)
Most of the code must be written in Python and tries to follow the PEP8 standard.
Documentation follows the Google documentation guidelines. Example.
In this section explain the train/predict conceptual architecture that the aplication has. We can add the train/predict conceptual architecture diagram.
In this section explain the deployed train/predict architecture that the aplication has. We can add the train/predict architecture diagram.
List of the Technologies that the project use
Example:
AWS | Languages | CI/CD |
---|---|---|
S3 | Python < Version > | Docker |
In this section, please put the detail (step by step) for make an execution, the code lines that an user has to make to make a complete execution of the algorithm
print('Code goes here!')