From cae1113a489754b0796cb6ac03f4abcb94bcc111 Mon Sep 17 00:00:00 2001 From: Michael Landreh Date: Fri, 19 Mar 2021 08:30:55 +0100 Subject: [PATCH 1/3] Clean up (#282) * removed hardcoded URL * Removed unnecessary endpoint --- .../viadee/sonarquest/controllers/login/LoginController.java | 5 ----- sonarQuest-frontend/src/app/services/websocket.service.ts | 2 +- 2 files changed, 1 insertion(+), 6 deletions(-) diff --git a/sonarQuest-backend/src/main/java/com/viadee/sonarquest/controllers/login/LoginController.java b/sonarQuest-backend/src/main/java/com/viadee/sonarquest/controllers/login/LoginController.java index d4f0a9c4..e250ebe8 100644 --- a/sonarQuest-backend/src/main/java/com/viadee/sonarquest/controllers/login/LoginController.java +++ b/sonarQuest-backend/src/main/java/com/viadee/sonarquest/controllers/login/LoginController.java @@ -36,11 +36,6 @@ public class LoginController { @Autowired private UserService userService; - @GetMapping - public String info() { - return "Dies ist eine Login Seite"; - } - @PostMapping public Token login(@Valid @RequestBody final UserCredentials credentials) { diff --git a/sonarQuest-frontend/src/app/services/websocket.service.ts b/sonarQuest-frontend/src/app/services/websocket.service.ts index 6acedd69..7460e3f7 100644 --- a/sonarQuest-frontend/src/app/services/websocket.service.ts +++ b/sonarQuest-frontend/src/app/services/websocket.service.ts @@ -13,7 +13,7 @@ import { User } from 'app/Interfaces/User'; @Injectable() export class WebsocketService { - private serverUrl = 'http://localhost:8080/socket'; + private serverUrl = '/api/socket'; private stompClient; private user: User; private currentWorld: World; From dc5e3cd0cf1360e5d536005e6efcdf6abfddbc3e Mon Sep 17 00:00:00 2001 From: Nils Uhrberg Date: Wed, 24 Mar 2021 00:07:29 +0100 Subject: [PATCH 2/3] Add illustrations for feature and hotfix branches to use in CONTRIBUTING.md Image source: https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow. License checked --- docs/images/gitflow_feature.svg | 1 + docs/images/gitflow_hotfix.svg | 1 + 2 files changed, 2 insertions(+) create mode 100644 docs/images/gitflow_feature.svg create mode 100644 docs/images/gitflow_hotfix.svg diff --git a/docs/images/gitflow_feature.svg b/docs/images/gitflow_feature.svg new file mode 100644 index 00000000..c9c66b84 --- /dev/null +++ b/docs/images/gitflow_feature.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/images/gitflow_hotfix.svg b/docs/images/gitflow_hotfix.svg new file mode 100644 index 00000000..7774eedb --- /dev/null +++ b/docs/images/gitflow_hotfix.svg @@ -0,0 +1 @@ + \ No newline at end of file From 5449210bedb370312011c81e8c9170c5824aef23 Mon Sep 17 00:00:00 2001 From: Nils Uhrberg Date: Wed, 24 Mar 2021 00:08:24 +0100 Subject: [PATCH 3/3] Add branching section into to use in CONTRIBUTING.md Describe the use of Gitflow in SonarQuest --- CONTRIBUTING.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 556592d3..2154e53b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -53,9 +53,25 @@ Here are some hints on what helps to get those approved and implemented as quick * there shouldn't be any TSLint warnings in the Angular parts of the code * we embrace Clean Code so when in doubt - take a look at Uncle Bob's book or [blog](http://blog.cleancoder.com/). +#### Branching +We want to keep the repository as clean and structured as possible. To achieve this, we use GitFlow as our Git workflow. Follow this [Link](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow "Gitflow Workflow | Atlassian Git Tutorial") to get more information about GitFlow. +In short, this means the following for your collaboration on SonarQuest: + +##### Feature Branch +If you want to add a great new feature to Sonar Quest or fix a major and minor issues, create a feature branch (`feature/`) based on the `develop` branch. After you are done, please create a pull request to merge your feature into `develop`. After a bunch of new features and fixes, we will create a new release that includes your implementations. +![Gitflow - Feature Branches](docs/images/gitflow_feature.svg) +*Image source: https://wac-cdn.atlassian.com/dam/jcr:b5259cce-6245-49f2-b89b-9871f9ee3fa4/03%20(2).svg?cdnVersion=1515, no changes made* + +##### Hotfix Branch +For quick patches of the release versions, please use hotfix branches (`hotfix/`). If there is a bug or an error that needs to be fixed, you can create your hotfix branch as a fork of the `master`. After your fix is ready, please create a pull request to merge the branch into `develop` **and** `master`. +![Gitflow - Feature Branches](docs/images/gitflow_hotfix.svg) +*Image source: https://wac-cdn.atlassian.com/dam/jcr:61ccc620-5249-4338-be66-94d563f2843c/05%20(2).svg?cdnVersion=1515, no changes made* + +For all other tasks around branching the SonarQuest core team takes care. If not everything is clear yet, feel free to have a look at the existing branches *(Be careful, there are also some older branches that don't conform to Gitflow yet. But you will recognize that)*. If you still have questions, feel free to contact us or open an issue. We will answer you as soon as possible. + #### Suggesting Pull Request -When you are adding features or other enhancements please create a pull request with a clear documentation of what you've done and why you have done it. It helps, if you make make sure all of your commits are atomic (one feature per commit). +When you are adding features or other enhancements please create a pull request as described in the previous [section](#branching), with a clear documentation of what you've done and why you have done it. It helps, if you make sure all of your commits are atomic (one feature per commit). Always include a useful log message for your commits. One-line messages are fine for small changes, but bigger changes should be commitetd with more comments, too.