Merge pull request #1484 from SciCatProject/master

release 11-05-2024

.github/ISSUE_TEMPLATE/issue-template.md

@@ -1,25 +1,23 @@
 ---
 name: Issue template
-about: Describe this issue purpose here.
-
+about: Generic template for backend issues
 ---
 
-## Issue Name (title)
-Please enter the title for this github issue
+## Summary
+<!-- Description of the issue -->
 
-### Summary
-Description of the issue
+## Steps to Reproduce
+<!-- Describe how to reproduce the issue -->
 
-### Steps to Reproduce
-Describe how to reproduce the issue
+## Current Behaviour
+<!-- Describe the current behavior if it is relevant -->
 
-### Current Behaviour
-Describe the current behavior if it is relevant
+## Expected Behaviour
+<!-- Describe the expected behavior if it is relevant -->
 
-### Expected Behaviour
-Describe the expected behavior if it is relevant
+## Details
+<!-- Provide all the details related to this issue. Also include screenshots, wireframes or mockups if they help.
+Link related issues in the frontend or other repositories if relevant. -->
 
-### Details
-Provide all the details related to this issue. Also include screenshots, wireframes or mockups if they help.
 
-__PS__: make sure to add the proper tags to the issue
+<!-- P.S. Make sure to add the proper tags to the issue -->

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,31 +1,38 @@
-## Description
+<!--
+Follow semantic-release guidelines for the PR title, which is used in the changelog.
 
-Short description of the pull request
+Title should follow the format `<type>(<scope>): <subject>`, where
+- Type is one of: build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test|BREAKING CHANGE
+- Scope (optional) describes the place of the change (eg a particular milestone) and is usually omitted
+- subject should be a non-capitalized one-line description in present imperative tense and not ending with a period
 
-## Motivation
+See https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines for more details.
+-->
 
-Background on use case, changes needed
+## Description
+<!-- Short description of the pull request -->
 
-## Fixes:
-Please provide a list of the fixes implemented by this PR
+## Motivation
+<!-- Background on use case, changes needed -->
 
-* Items added
+## Fixes
+<!-- Please provide a list of the issues fixed by this PR -->
+
+* Bug fixed (#X)
 
 ## Changes:
-Please provide a list of the changes implemented by this PR
+<!-- Please provide a list of the changes implemented by this PR -->
 
 * changes made
 
 ## Tests included
 
 - [ ] Included for each change/fix?
-- [ ] Passing? (Merge will not be approved unless this is checked) 
+- [ ] Passing? <!-- Merge will not be approved unless tests pass -->
 
 ## Documentation
-- [ ] swagger documentation updated \[required\]
-- [ ] official documentation updated \[nice-to-have]
+- [ ] swagger documentation updated (required for API changes)
+- [ ] official documentation updated
 
 ### official documentation info
-If you have updated the official documentation, please provide PR # and URL of the pages where the updates are included
-
-
+<!-- If you have updated the official documentation, please provide PR # and URL of the updated pages -->

.github/pr-title-checker-config.json

@@ -9,7 +9,7 @@
   },
   "MESSAGES": {
     "success": "All OK",
-    "failure": "PR title not following the semantic-release guidelines. Please check https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines for more information.",
+    "failure": "PR title not following the semantic-release guidelines (<type>(<scope>): <subject>). Please check https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines for more information.",
     "notice": ""
   }
 }

.github/workflows/release-and-publish-sdk.yml

@@ -193,6 +193,7 @@ jobs:
         run: |
           npm install
           npm run build
+          cd dist
           npm publish --access public
         working-directory: ./sdk/typescript-angular/
         env: