docs(README): #354 update versioning heading in README

docs(what-to-expect-next): #354 update the section

docs(what-to-expect-next): #354 add generic issue template

Author: abhisheksr01

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,7 +1,7 @@
 ---
 name: "Bug Report"
 about: "Report a bug or unexpected behavior in the Spring Boot microservice"
-title: "bug(scope) - Short description of the issue"
+title: "bug(scope) - short description of the issue"
 labels: "bug"
 assignees: ""
 

.github/ISSUE_TEMPLATE/document_improvement.md

@@ -1,7 +1,7 @@
 ---
 name: "Documentation Improvement"
 about: "Suggest an improvement or correction to the project's documentation"
-title: "docs(scope) - Short description of the documentation issue"
+title: "docs(scope) - short description of the documentation issue"
 labels: "documentation"
 assignees: ""
 

.github/ISSUE_TEMPLATE/feature_request.md

@@ -22,7 +22,7 @@ This can be anything from CI tool integration, Security feature (use Security-De
 ## Benefits
 <!-- Describe the benefits of this feature and why it should be prioritized. -->
 
-### Example
+## Example
 <!-- - Provide examples of how the feature will work or how it will be used, if possible. -->
 
 ## Additional Information

.github/ISSUE_TEMPLATE/generic_report.md

@@ -0,0 +1,20 @@
+---
+name: "Generic Report"
+about: "Request a change that does not classify with other issue types"
+title: "chore(scope) - brief description of the requested change"
+labels: "vulnerabilities"
+assignees: "good first issue"
+
+---
+
+## Description
+<!-- 
+A clear and concise description of the request in this repository.
+This request template should only be used in case when the request type do not match other issue types. 
+-->
+
+## Use Case
+<!-- Describe the problem or use case you're trying to solve with this feature. -->
+
+## Additional Information
+<!-- Any other details, mockups, or context that may help in understanding the request. -->

.github/ISSUE_TEMPLATE/security_vulnerability_report.md

@@ -1,7 +1,7 @@
 ---
 name: "Security Vulnerability Report"
 about: "Report a potential security vulnerability in the Spring Boot microservice repository"
-title: "security(scope) - Brief description of the vulnerability"
+title: "security(scope) - brief description of the vulnerability"
 labels: "vulnerabilities"
 assignees: ""
 
@@ -23,7 +23,7 @@ assignees: ""
 ## Suggested Mitigation or Fix
 <!-- If known, provide any suggestions for mitigating the vulnerability or fixing the issue. -->
 
-### CVSS Score (Optional)
+## CVSS Score (Optional)
 <!-- If you are aware of the Common Vulnerability Scoring System (CVSS) score, please include it to help assess the severity. -->
 
 ## Additional Information

README.md

@@ -552,8 +552,8 @@ In this section we are going to explore [OWASP ZAP](https://www.zaproxy.org/docs
       -t [TARGET_REST_API] -g gen.conf -r pentest-report.html
   ```
 
-  | Parameter       |      Description                         |
-  |-----------------|:---------------------------------------- |
+  | Parameter       | Description                              |
+  |-----------------|:-----------------------------------------|
   | $(pwd)          | Directory where report will be generated |
   | zap-baseline.py | Zap's python script                      |
   | -t [TARGET_URL] | URL to be Pen Tested                     |
@@ -1061,22 +1061,49 @@ Cloud Run is available in below two flavours:
 
 ### What to Expect Next!
 
-As the world of software engineering is evolving so we do.<br/>
-Listing down some of the exciting features am going to work on and update the GitHub in coming days, they are:
+As software engineering continues to evolve, we do too.
 
-- GitHub Actions
-- Chaos Monkey
-- Hystrix
-- CORS (Cross-Origin)
+All planned tasks for this repository are tracked in the [GitHub Issues](https://github.com/abhisheksr01/spring-boot-microservice-best-practices/issues) section.
+
+If you'd like to propose new work or enhancements for this repository, please create a **New Issue** using the appropriate issue type.
 
 ### Versioning
 
-We use [SemVer](http://semver.org/) for versioning. For the versions
-available, see the
-[tags on this repository](https://github.com/your/project/tags).
+We use [Cocogitto](https://github.com/cocogitto/cocogitto) for releasing [Semantic SemVer](http://semver.org/) versioned GitHub releases in this repository.
 
-### License
+Check the [Releases](https://github.com/abhisheksr01/spring-boot-microservice-best-practices/releases) section in repository to know the latest releases.
+
+The GitHub releases are automated in the GHA CI based on [Cocogitto's conventional commit types](https://docs.cocogitto.io/guide/commit.html).
+
+<details>
+
+<summary>Clicks here for details on this repository automated the releases.</summary>
+
+#### GHA CI release flow
 
-This project is licensed under the MIT License - see the
-[LICENSE.md](LICENSE.md) file for details
+- When a change is committed to the repository with conventional commit type the GHA CI pipeline is triggered
+- The `docker-build-push` job `cog-bump` step validates whether a version bump is required or not and if required then calculates the new version based on conventional commit type
+- In the `docker-build-push` job we pass an dryrun argument to `cog-bump` step which only provides the version to be bumped.
+- Then we build the image with this new version and test the changes.
+- Once all the changes are verified in the CI we publish the latest version tags and publish a GitHub release with all the relevant changes.
+
+</details>
+
+- We utilize [Cocogitto](https://github.com/cocogitto/cocogitto) to automate the process of creating [Semantic SemVer](http://semver.org/) GitHub releases for this repository.
+- For information on the latest [releases](https://docs.github.com/en/repositories/releasing-projects-on-github/about-releases), please visit the Releases section of the repository.
+- The release process is automated through GitHub Actions (GHA CI), following [Cocogitto's conventional commit types](https://docs.cocogitto.io/guide/commit.html)..
+
+<details>
+<summary>Click here for details on how the releases are automated in this repository.</summary>
+
+#### GHA CI Release Process
+- When a commit is made with a conventional commit type, the GHA CI pipeline is triggered.
+- After all the validations the **docker-build-push** job runs the cog-bump step, which checks whether a version bump is necessary. If a bump is needed, it calculates the new version based on the conventional commit type.
+- During this process, we pass a `dry-run: true` argument to the **cog-bump** step to only calculate (but not apply) the version bump.
+- The CI pipeline then builds the Docker image with the new version and tests the changes.
+- Once the changes are verified, the **create-release** job publishes new tags with bumped current version and a GitHub release is created.
+</details>
+
+### License
 
+This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details