Skip to content

Add PR template generation and opening skills; update Makefile and .gitignore for PR management#1

Merged
Software78 merged 14 commits intomainfrom
docs/readme
Mar 29, 2026
Merged

Add PR template generation and opening skills; update Makefile and .gitignore for PR management#1
Software78 merged 14 commits intomainfrom
docs/readme

Conversation

@Software78
Copy link
Copy Markdown
Contributor

@Software78 Software78 commented Mar 29, 2026

Summary

Adds a root README with project overview, toolchain expectations (Go 1.22+, optional lint/security tools), and common Makefile workflows (tools, check, individual targets). Uncommitted work on the branch also adds make pr-description (scaffold from .github/pull_request_template.md into gitignored pr_template/) and the matching .gitignore entry—commit those if this PR should include the PR-draft workflow.

Related Issue(s)

Not tied to a tracked issue; onboarding documentation and optional local PR scaffolding.

Type of Change

  • feat — New feature
  • fix — Bug fix
  • docs — Documentation only
  • refactor — No functional change
  • test — Adding or updating tests
  • chore — Build, tooling, or dependency update
  • perf — Performance improvement
  • breaking — Breaking change (existing functionality affected)

Changes Made

  • README.md: Angle HR server intro, requirements, clone/quick start, make tools / make check, links to CONTRIBUTING / security / roadmap.
  • Makefile (if included in the PR): pr-description target; copies the GitHub PR template into pr_template/pr-<branch>.md and appends branch/commit context vs main.
  • .gitignore: ignore pr_template/ for local PR drafts.

How to Test

  1. Read README.md and confirm links and commands match the repo (CI workflows, Go version).
  2. If Makefile changes are part of the PR: run make pr-description and confirm output under pr_template/ and that git status does not track pr_template/ after the ignore is committed.
  3. make test / go test ./... currently fail at the repo root because there is no go.mod yet; treat as a known repo state until a module exists.

Screenshots / Recordings (if applicable)

N/A.

Checklist

  • My branch is up to date with main.
  • I've followed the commit convention.
  • I've added or updated tests to cover my changes.
  • All existing tests pass locally.
  • I've updated documentation where needed.
  • I've checked for and resolved any merge conflicts.
  • This PR does not introduce secrets, credentials, or debug statements.

@github-actions
Copy link
Copy Markdown

📊 Test Coverage

Metric Value
Total Coverage 88.9%
Threshold 70%

Download the full report from the workflow artifacts.

@github-advanced-security
Copy link
Copy Markdown

You are seeing this message because GitHub Code Scanning has recently been set up for this repository, or this pull request contains the workflow file for the Code Scanning tool.

What Enabling Code Scanning Means:

  • The 'Security' tab will display more code scanning analysis results (e.g., for the default branch).
  • Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results.
  • You will be able to see the analysis results for the pull request's branch on this overview once the scans have completed and the checks have passed.

For more information about GitHub Code Scanning, check out the documentation.

…ttings, and adjust output formats for improved readability and functionality.
@github-actions
Copy link
Copy Markdown

📊 Test Coverage

Metric Value
Total Coverage 88.9%
Threshold 70%

Download the full report from the workflow artifacts.

… consistency and compatibility with configuration schema.
@github-actions
Copy link
Copy Markdown

📊 Test Coverage

Metric Value
Total Coverage 88.9%
Threshold 70%

Download the full report from the workflow artifacts.

@github-actions
Copy link
Copy Markdown

📊 Test Coverage

Metric Value
Total Coverage 88.9%
Threshold 70%

Download the full report from the workflow artifacts.

@github-actions
Copy link
Copy Markdown

📊 Test Coverage

Metric Value
Total Coverage 88.9%
Threshold 70%

Download the full report from the workflow artifacts.

…d upgrade SARIF upload action to v4 for enhanced functionality.
@github-actions
Copy link
Copy Markdown

📊 Test Coverage

Metric Value
Total Coverage 88.9%
Threshold 70%

Download the full report from the workflow artifacts.

…sting local-prefixes format and ensuring proper newline at end of file.
@github-actions
Copy link
Copy Markdown

📊 Test Coverage

Metric Value
Total Coverage 88.9%
Threshold 70%

Download the full report from the workflow artifacts.

@Software78 Software78 requested a review from Jerry-Ol March 29, 2026 13:18
…or installing git hooks and running quality checks. Introduce a pre-commit hook to enforce quality gate checks before commits.
@github-actions
Copy link
Copy Markdown

📊 Test Coverage

Metric Value
Total Coverage 88.9%
Threshold 70%

Download the full report from the workflow artifacts.

@Software78 Software78 merged commit 3563c5e into main Mar 29, 2026
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants