Align repository with DPC conventions

[Copilot]

Brings the repository into compliance with the DPC conventions by adding all required documentation files and GitHub Actions workflows.

Documentation

• README.md – Restructured with all 10 required DPC sections (Description → Installation → Usage → Support → Contributing → Testing → Development → Authors → License → Project Status); replaces the previous ad-hoc layout
• CONTRIBUTING.md – New; covers requirements, fork/clone workflow, issue/milestone tracking, branch model (develop-based), and test instructions
• USER_GUIDE.md – New; prerequisites, quick-start for CLI and web modes, common scenarios, output structure, rate limits
• COMMANDS.md – New; CLI arguments, interactive-mode commands, JVM system properties (-Dbackup.directory, -Dspring.profiles.active, -Dserver.port), GITHUB_TOKEN env var, and REST API endpoints
• CONFIG.md – New; documents every application.properties key with type, default, and runtime-override examples
• CHANGELOG.md – New; Keep a Changelog format, v1.0.0 entry

CI / Automation

• .github/workflows/build.yml – Triggers on push/PR to main and develop; runs mvn clean verify; scoped to permissions: contents: read
• .github/workflows/release.yml – Triggers on release creation; builds and attaches target/gh-backup-*.jar via softprops/action-gh-release@v2; declares permissions: contents: write

Copilot

• .github/copilot-instructions.md – New; links to DPC conventions, describes the Maven/Spring Boot stack, key source directories, coding conventions, and the develop-branch PR workflow

All workflow and doc templates from the conventions are adapted for Maven (the project uses mvn, not ./gradlew).

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

• https://api.github.com/orgs/this-user-definitely-does-not-exist-12345678
  • Triggering command: /usr/lib/jvm/temurin-17-jdk-amd64/bin/java /usr/lib/jvm/temurin-17-jdk-amd64/bin/java -jar /home/REDACTED/work/gh-backup/gh-backup/target/surefire/surefirebooter-20260323002047843_3.jar /home/REDACTED/work/gh-backup/gh-backup/target/surefire 2026-03-23T00-20-47_421-jvmRun1 surefire-20260323002047843_1tmp surefire_0-20260323002047843_2tmp (http block)
• https://api.github.com/user
  • Triggering command: /usr/lib/jvm/temurin-17-jdk-amd64/bin/java /usr/lib/jvm/temurin-17-jdk-amd64/bin/java -jar /home/REDACTED/work/gh-backup/gh-backup/target/surefire/surefirebooter-20260323002047843_3.jar /home/REDACTED/work/gh-backup/gh-backup/target/surefire 2026-03-23T00-20-47_421-jvmRun1 surefire-20260323002047843_1tmp surefire_0-20260323002047843_2tmp (http block)
• https://api.github.com/users/this-user-definitely-does-not-exist-12345678
  • Triggering command: /usr/lib/jvm/temurin-17-jdk-amd64/bin/java /usr/lib/jvm/temurin-17-jdk-amd64/bin/java -jar /home/REDACTED/work/gh-backup/gh-backup/target/surefire/surefirebooter-20260323002047843_3.jar /home/REDACTED/work/gh-backup/gh-backup/target/surefire 2026-03-23T00-20-47_421-jvmRun1 surefire-20260323002047843_1tmp surefire_0-20260323002047843_2tmp (http block)

If you need me to access, download, or install something from one of these locations, you can either:

• Configure Actions setup steps to set up my environment, which run before the firewall is enabled
• Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

Original prompt

Align this repository with the DPC (Dans Plugins Community) conventions defined at
https://github.com/Dans-Plugins/dpc-conventions.

Read each of the following convention documents in full before making any changes:

• README structure: https://github.com/Dans-Plugins/dpc-conventions/blob/main/docs/README_STRUCTURE.md
• Documentation practices: https://github.com/Dans-Plugins/dpc-conventions/blob/main/docs/DOCUMENTATION_PRACTICES.md
• Contributing standards: https://github.com/Dans-Plugins/dpc-conventions/blob/main/docs/CONTRIBUTING_STANDARDS.md
• Testing and CI: https://github.com/Dans-Plugins/dpc-conventions/blob/main/docs/TESTING_AND_CI.md
• Release automation: https://github.com/Dans-Plugins/dpc-conventions/blob/main/docs/RELEASE_AUTOMATION.md
• GitHub Copilot instructions: https://github.com/Dans-Plugins/dpc-conventions/blob/main/docs/GITHUB_COPILOT_INSTRUCTIONS.md

Then perform the following steps:

1. Inspect the repository — read README.md, CONTRIBUTING.md, any existing docs/, and
   .github/workflows/ files to understand the current state.

2. Build a gap checklist comparing the repo against every requirement in the convention
   documents above.

3. Implement all required changes directly in the repository:

   • Update README.md to include all required sections in the correct order, following
     the templates in README_STRUCTURE.md.
   • Create or update CONTRIBUTING.md using the template in CONTRIBUTING_STANDARDS.md.
   • Create any missing documentation files (USER_GUIDE.md, COMMANDS.md, CONFIG.md,
     CHANGELOG.md) with appropriate starter content derived from the plugin's existing
     code and configuration.
   • Add or update .github/workflows/build.yml using the CI template in TESTING_AND_CI.md.
   • Add or update .github/workflows/release.yml using the template in RELEASE_AUTOMATION.md.
   • Create or update .github/copilot-instructions.md using the template in GITHUB_COPILOT_INSTRUCTIONS.md.
   • Make any other changes needed to satisfy the conventions.

4. Do not restate convention rules in commit messages or comments — reference the
   relevant convention document URL instead.

Keep changes minimal and focused on closing the identified gaps. Do not refactor
existing code or alter plugin behaviour.

---

📱 Kick off Copilot coding agent tasks wherever you are with GitHub Mobile, available on iOS and Android.