Cleanup #11
Cleanup #11
Conversation
…nto the doc folder
ASSESSMENT.md
Outdated
|
|
||
| - Must be able to start from a cloned git repo. | ||
| - Must document any pre-requisites clearly. | ||
| - Must be contained within a GitHub project. |
There was a problem hiding this comment.
Change this to GitHub Repository as GitHub does have the concept of "Projects", which is not what we mean
ASSESSMENT.md
Outdated
|
|
||
| #### Security | ||
|
|
||
| - Network segmentation |
There was a problem hiding this comment.
Add (if applicable to the implementation), as someone might run this in Fargate or something where it's not really as relevant
| #### Simplicity | ||
|
|
||
| - No superfluous dependencies | ||
| - Do not over engineer the solution |
|
|
||
| Please note we have a code of conduct, please follow it in all your interactions with the project. | ||
|
|
||
| ## Pull Request Process |
There was a problem hiding this comment.
Consider adding a pull request template
| @@ -32,7 +32,7 @@ var versionCmd = &cobra.Command{ | |||
| Short: "Displays the current version", | |||
| Long: `Displays the current version of the application`, | |||
| Run: func(cmd *cobra.Command, args []string) { | |||
| fmt.Println("Version: 0.2.3-pre-release") | |||
| fmt.Println("Version: 0.2.4") | |||
There was a problem hiding this comment.
In Cobra, the version command should just be an attribute of the root cobra.Command see example here
doc/readme.md
Outdated
|
|
||
| The application itself is a React based single page application (SPA) with an API backend and a postgres database used for data persistence. It's been designed to be completely stateless and will deploy into most types of environments, be it container based or VM based. | ||
|
|
||
| ## Deploying into the cloud - scaffolds |
There was a problem hiding this comment.
This is more an architectural point, but I'm not sure we should provide the scaffolding; We want to see how modularly they can build a solution, and this also introduces too much complexity for them to get up and running. I reckon scrap it and let them provide a self-contained solution which we can spin up.
| @@ -16,107 +16,16 @@ | |||
|
|
|||
There was a problem hiding this comment.
should add a title here # TechTestApp
There was a problem hiding this comment.
Also, I think bring doc/readme.md back into here. Otherwise, put a couple of links to doc/readme.md and ASSESSMENT.md in here somewhere
There was a problem hiding this comment.
I wanted to split the readme for the app from the test, why I went with the doc/readme.md. It's already linked at line 23
There is already a title in the ./readme.md file, # Vibrato Tech Test or do you think it should be changed?
doc/readme.md
Outdated
|
|
||
| To create a new release, update `../cmd/version.go` with the new version and merge that into the master branch. | ||
|
|
||
| The commit message on the merge, will be the releas message, so make sure it contains the release notes. |
|
|
||
| Releases are deployed and managed through github, it's an automated process that is executed through the CI solution | ||
|
|
||
| To create a new release, update `../cmd/version.go` with the new version and merge that into the master branch. |
There was a problem hiding this comment.
Ideally should use the Cobra-native method mentioned above
doc/readme.md
Outdated
|
|
||
| A tag will be created on the master branch if the build and release is successful. | ||
|
|
||
| We use semver for versioning, `major.minor.patch[-pre-release]` and the CI solution has been configured to take note of the `-pre-release` tag of the version and upload it as a pre-release in git if it's included. So to release a new full release, make sure to not include `-pre-release` and visa versa. |
Cleaned up the repository to make it a bit more polished, added in a few bits and pieces around how to contribute, and more details about how to work with the application