chore(os): implement open source readiness and CI/CD automation

- Updated GitHub Actions workflow for automated Maven build and test on Java 21
- Create SECURITY.md to define vulnerability reporting policy
- Implement GitHub Issue templates for bug reports and feature requests
- Update README.md with status badges (CI/CD, License, Security)
- Standardize documentation and quickstart instructions for public release

Author: Sympol

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -1,42 +1,41 @@
 name: Bug Report
-description: File a report to help us improve PCM
-title: "[BUG] "
+description: Create a report to help us improve PCM
 labels: ["bug"]
 body:
   - type: markdown
     attributes:
       value: |
         Thanks for taking the time to fill out this bug report!
   - type: textarea
-    id: what-happened
+    id: description
     attributes:
-      label: What happened?
-      description: Also tell us what you expected to happen.
-      placeholder: Tell us what you see!
+      label: Describe the bug
+      description: A clear and concise description of what the bug is.
     validations:
       required: true
   - type: textarea
-    id: reproduction-steps
+    id: reproduction
     attributes:
-      label: Steps to reproduce
-      description: How can we make this happen ourselves?
+      label: Steps to Reproduce
+      description: How can we reproduce this issue?
       placeholder: |
-        1. Start platform with scripts/start-platform.sh
+        1. Start the platform using ...
         2. Call endpoint ...
         3. See error ...
     validations:
       required: true
   - type: textarea
-    id: environment
+    id: expected
     attributes:
-      label: Environment
-      description: OS, Java version, Docker version, etc.
-      placeholder: macOS 14.2, Java 21, Docker 24.0.7
-    validations:
-      required: true
+      label: Expected Behavior
+      description: What did you expect to happen?
+  - type: input
+    id: version
+    attributes:
+      label: PCM Version
+      description: e.g. 0.1.0-SNAPSHOT
   - type: textarea
     id: logs
     attributes:
-      label: Relevant Log Output
-      description: Please copy and paste any relevant log output or stack traces.
-      render: shell
+      label: Relevant Logs
+      description: Please paste any relevant logs or error messages.

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -1,15 +1,12 @@
 name: Feature Request
 description: Suggest an idea for PCM
-title: "[FEATURE] "
 labels: ["enhancement"]
 body:
   - type: textarea
-    id: feature-description
+    id: problem
     attributes:
       label: Is your feature request related to a problem?
-      description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
-    validations:
-      required: true
+      description: A clear and concise description of what the problem is.
   - type: textarea
     id: solution
     attributes:
@@ -23,7 +20,7 @@ body:
       label: Describe alternatives you've considered
       description: A clear and concise description of any alternative solutions or features you've considered.
   - type: textarea
-    id: additional-context
+    id: additional
     attributes:
       label: Additional context
       description: Add any other context or screenshots about the feature request here.

.github/workflows/ci.yml

@@ -1,28 +1,31 @@
-name: build
+name: PCM CI/CD
 
 on:
   push:
-    branches: [ main, develop ]
+    branches: [ "main", "develop" ]
   pull_request:
-    branches: [ main ]
+    branches: [ "main", "develop" ]
 
 jobs:
   build:
     runs-on: ubuntu-latest
+
+    services:
+      # Optional: In the future, we can add PostgreSQL/Kafka for integration tests
+      # For now, we focus on compilation and unit tests
+
     steps:
     - uses: actions/checkout@v4
-    
+
     - name: Set up JDK 21
       uses: actions/setup-java@v4
       with:
         java-version: '21'
         distribution: 'temurin'
         cache: maven
-        
+
     - name: Build with Maven
-      run: mvn -B clean install -DskipTests
-      
-    - name: Run Tests
-      run: mvn -B test -Dpact.verifier.publishResults=true
-      env:
-        TESTCONTAINERS_RYUK_DISABLED: true # Often helpful in CI constrained environments
+      run: mvn -B clean install -DskipTests # Skip tests initially to ensure compilation across all stacks
+
+    - name: Run Unit Tests
+      run: mvn -B test

README.md

@@ -9,6 +9,8 @@
 [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)
 [![Java](https://img.shields.io/badge/Java-21-orange.svg)](https://openjdk.org/projects/jdk/21/)
 [![Spring Boot](https://img.shields.io/badge/Spring%20Boot-3.2-green.svg)](https://spring.io/projects/spring-boot)
+[![CI/CD](https://github.com/vibe-afrika/pcm/actions/workflows/ci-cd.yml/badge.svg)](https://github.com/vibe-afrika/pcm/actions/workflows/ci-cd.yml)
+[![Security Policy](https://img.shields.io/badge/Security-Policy-brightgreen.svg)](SECURITY.md)
 
 ---
 

SECURITY.md

@@ -2,22 +2,17 @@
 
 ## Supported Versions
 
-We currently provide security updates for the following versions:
+The following versions of PCM are currently being supported with security updates:
 
 | Version | Supported          |
 | ------- | ------------------ |
 | 0.1.x   | :white_check_mark: |
-| < 0.1.0 | :x:                |
+| < 0.1   | :x:                |
 
 ## Reporting a Vulnerability
 
-We take the security of PCM seriously. If you believe you have found a security vulnerability, please do NOT report it publicly in the issue tracker.
+We take the security of PCM seriously. If you believe you have found a security vulnerability, please report it to us by emailing [EMAIL_ADDRESS].
 
-Instead, please send an email to **security@vibe-afrika.dev**.
+Please do **not** open a public GitHub issue for security vulnerabilities.
 
-Please include:
-- A description of the vulnerability.
-- Steps to reproduce the issue.
-- Potential impact.
-
-We will acknowledge your report within 48 hours and provide a timeline for a fix. We follow a responsible disclosure policy.
+After you report a vulnerability, we will acknowledge your email within 48 hours and provide a timeline for a fix. We follow a responsible disclosure policy and ask that you give us reasonable time to fix the issue before making it public.