upstream merge template repository

.github/CODE_OF_CONDUCT.md

@@ -2,127 +2,51 @@
 
 ## Our Pledge
 
-We as members, contributors, and leaders pledge to make participation in our
-community a harassment-free experience for everyone, regardless of age, body
-size, visible or invisible disability, ethnicity, sex characteristics, gender
-identity and expression, level of experience, education, socio-economic status,
-nationality, personal appearance, race, religion, or sexual identity
-and orientation.
+We pledge to make participation in our community harassment-free for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, experience level, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
 
-We pledge to act and interact in ways that contribute to an open, welcoming,
-diverse, inclusive, and healthy community.
+We pledge to act in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
 
 ## Our Standards
 
-Examples of behavior that contributes to a positive environment for our
-community include:
+Examples of positive behavior include:
 
-- Demonstrating empathy and kindness toward other people
-- Being respectful of differing opinions, viewpoints, and experiences
+- Demonstrating empathy and kindness
+- Being respectful of differing opinions and experiences
 - Giving and gracefully accepting constructive feedback
-- Accepting responsibility and apologizing to those affected by our mistakes,
- and learning from the experience
-- Focusing on what is best not just for us as individuals, but for the
- overall community
+- Taking responsibility and apologizing for mistakes
+- Focusing on what is best for the community
 
-Examples of unacceptable behavior include:
+Unacceptable behavior includes:
 
-- The use of sexualized language or imagery, and sexual attention or
- advances of any kind
+- Sexualized language or imagery and unwelcome advances
 - Trolling, insulting or derogatory comments, and personal or political attacks
 - Public or private harassment
-- Publishing others' private information, such as a physical or email
- address, without their explicit permission
-- Other conduct which could reasonably be considered inappropriate in a
- professional setting
+- Publishing others' private information without permission
+- Other conduct inappropriate in a professional setting
 
 ## Enforcement Responsibilities
 
-Community leaders are responsible for clarifying and enforcing our standards of
-acceptable behavior and will take appropriate and fair corrective action in
-response to any behavior that they deem inappropriate, threatening, offensive,
-or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject
-comments, commits, code, wiki edits, issues, and other contributions that are
-not aligned to this Code of Conduct, and will communicate reasons for moderation
-decisions when appropriate.
+Community leaders are responsible for clarifying and enforcing standards and will take appropriate corrective action in response to inappropriate behavior.
 
 ## Scope
 
-This Code of Conduct applies within all community spaces, and also applies when
-an individual is officially representing the community in public spaces.
-Examples of representing our community include using an official e-mail address,
-posting via an official social media account, or acting as an appointed
-representative at an online or offline event.
+This Code of Conduct applies within all community spaces and in public spaces when representing the community.
 
 ## Enforcement
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported to the community leaders responsible for enforcement at
-.
-All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the
-reporter of any incident.
+Instances of abusive or unacceptable behavior may be reported to community leaders. All complaints will be reviewed and investigated promptly and fairly. Privacy and security of the reporter will be respected.
 
 ## Enforcement Guidelines
 
-Community leaders will follow these Community Impact Guidelines in determining
-the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed
-unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing
-clarity around the nature of the violation and an explanation of why the
-behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series
-of actions.
-
-**Consequence**: A warning with consequences for continued behavior. No
-interaction with the people involved, including unsolicited interaction with
-those enforcing the Code of Conduct, for a specified period of time. This
-includes avoiding interactions in community spaces as well as external channels
-like social media. Violating these terms may lead to a temporary or
-permanent ban.
+Community leaders will follow these guidelines:
 
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including
-sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public
-communication with the community for a specified period of time. No public or
-private interaction with the people involved, including unsolicited interaction
-with those enforcing the Code of Conduct, is allowed during this period.
-Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior, harassment of an
-individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within
-the community.
+1. **Correction**: A private, written warning, clarifying the nature of the violation and explaining why the behavior was inappropriate. A public apology may be requested.
+2. **Warning**: A warning with consequences for continued behavior, including a temporary ban from interaction with the community.
+3. **Temporary Ban**: A temporary ban from interaction with the community. Violating these terms may lead to a permanent ban.
+4. **Permanent Ban**: A permanent ban from the community for repeated violations or severe misconduct.
 
 ## Attribution
 
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 2.0, available at
-<https://www.contributor-covenant.org/version/2/0/code_of_conduct.html>.
-
-Community Impact Guidelines were inspired by [Mozilla's code of conduct
-enforcement ladder](https://github.com/mozilla/diversity).
-
-[homepage]: https://www.contributor-covenant.org
+This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.0.
 
-For answers to common questions about this code of conduct, see the FAQ at
-<https://www.contributor-covenant.org/faq>. Translations are available at
-<https://www.contributor-covenant.org/translations>.
+For answers to common questions about this code of conduct, see the FAQ at <https://www.contributor-covenant.org/faq>. Translations are available at <https://www.contributor-covenant.org/translations>.

.github/CONTRIBUTING.md

@@ -1 +1,46 @@
-# Contributing guide
+# Contributing to This Project
+
+Thank you for considering contributing! Here are some guidelines to help you get started.
+
+## Code of Conduct
+
+Please note that this project adheres to a [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
+
+## How Can I Contribute?
+
+### Reporting Bugs
+
+If you find a bug, please open an issue with a detailed description of the problem and steps to reproduce it.
+
+### Suggesting Enhancements
+
+Enhancement suggestions are welcome! Please open an issue to discuss the suggestion before implementing it.
+
+### Submitting Pull Requests
+
+1. Fork the repository.
+2. Create a new branch for your feature or bugfix.
+3. Make your changes.
+4. Ensure the changes adhere to the project's coding standards.
+5. Commit your changes with a clear message.
+6. Push your branch to your fork.
+7. Open a pull request against the main branch of the original repository.
+
+## Style Guides
+
+### Coding Standards
+
+- Write clear, concise, and well-documented code.
+- Follow existing code patterns and styles.
+
+### Commit Messages
+
+- Use the imperative mood in the subject lines
+- Provide a detailed description of the change.
+
+*Or don't, but you will need to be available to answers any questions.*
+
+## Additional Notes
+
+- Issues and pull requests will be reviewed as soon as possible.
+- Please be patient and respectful to maintain a positive environment.

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,10 +1,9 @@
 ---
 name: Bug report
 about: Create a report to help us improve
-title: ''
-labels: ''
+title: 'Bug Report'
+labels: 'Bug'
 assignees: ''
-
 ---
 
 **Describe the bug**
@@ -38,4 +37,4 @@ If applicable, add screenshots to help explain your problem.
 - Version [e.g. 22]
 
 **Additional context**
-Add any other context about the problem here.
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/custom.md

@@ -0,0 +1,7 @@
+---
+name: Custom issue template
+about: Describe this issue template's purpose here.
+title: 'Custom Issue'
+labels: ''
+assignees: ''
+---

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,10 +1,9 @@
 ---
 name: Feature request
 about: Suggest an idea for this project
-title: ''
-labels: ''
+title: 'Feature Request'
+labels: 'Feature'
 assignees: ''
-
 ---
 
 **Is your feature request related to a problem? Please describe.**

.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -1 +1,3 @@
-# Pull Request Template
+## Description
+
+Please provide a brief summary of the changes and the related issue. Try to provide as much information as possible.

.github/SECURITY.md

@@ -1,21 +1,13 @@
 # Security Policy
 
-## Supported Versions
-
-Use this section to tell people about which versions of your project are
-currently being supported with security updates.
+## Reporting a Vulnerability
 
-| Version | Supported          |
-| ------- | ------------------ |
-| 5.1.x   | :white_check_mark: |
-| 5.0.x   | :x:                |
-| 4.0.x   | :white_check_mark: |
-| < 4.0   | :x:                |
+If you discover a security vulnerability, please follow these steps:
 
-## Reporting a Vulnerability
+1. **Do not disclose it publicly** until we have had a chance to address it.
+2. Send an email to <security@holeinonestudios.org> with the details of the vulnerability.
+3. Provide as much detail as possible, including steps to reproduce the issue and any potential impact.
 
-Use this section to tell people how to report a vulnerability.
+We will acknowledge your report and work to investigate and address the issue as soon as possible. Once the issue is resolved, we will post an update in the repository. If you have a solution feel free to include that too.
 
-Tell them where to go, how often they can expect to get an update on a
-reported vulnerability, what to expect if the vulnerability is accepted or
-declined, etc.
+Thank you for helping to keep our project secure.

.github/dependabot.yml

@@ -1,11 +1,17 @@
+# Dependabot Configuration File
 # To get started with Dependabot version updates, you'll need to specify which
 # package ecosystems to update and where the package manifests are located.
 # Please see the documentation for all configuration options:
 # https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
 
 version: 2
 updates:
-  - package-ecosystem: "" # See documentation for possible values
-    directory: "/docs" # Location of package manifests
+  - package-ecosystem: ""
+    directory: "/src" # Location of package manifests for Maven
     schedule:
-      interval: "weekly"
+      interval: "weekly" # Update dependencies weekly
+
+  - package-ecosystem: "github-actions" # For GitHub Actions
+    directory: "/.github/workflows" # Location of GitHub Actions workflows
+    schedule:
+      interval: "weekly" # Update dependencies weekly

.github/workflows/greetings.yml

@@ -0,0 +1,16 @@
+name: Greetings
+
+on: [pull_request_target, issues]
+
+jobs:
+  greeting:
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+      pull-requests: write
+    steps:
+      - uses: actions/first-interaction@v1
+        with:
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+          issue-message: "Thank you for your issue report! I will look into it as soon as possible."
+          pr-message: "Thank you for your pull request! I will look into it as soon as possible."

.github/workflows/pages.yml

@@ -29,14 +29,14 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Setup Pages
-        uses: actions/configure-pages@v1
+        uses: actions/configure-pages@v5
       - name: Upload artifact
-        uses: actions/upload-pages-artifact@v1
+        uses: actions/upload-pages-artifact@v3
         with:
           # Upload entire repository
-          path: './src'
+          path: './src/'
       - name: Deploy to GitHub Pages
         id: deployment
         uses: actions/deploy-pages@v1

.github/workflows/stale.yml

@@ -0,0 +1,27 @@
+# This workflow warns and then closes issues and PRs that have had no activity for a specified amount of time.
+#
+# You can adjust the behavior by modifying this file.
+# For more information, see:
+# https://github.com/actions/stale
+name: Mark stale issues and pull requests
+
+on:
+  schedule:
+  - cron: '17 10 * * *'
+
+jobs:
+  stale:
+
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+      pull-requests: write
+
+    steps:
+    - uses: actions/stale@v9
+      with:
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
+        stale-issue-message: 'Stale issue message'
+        stale-pr-message: 'Stale pull request message'
+        stale-issue-label: 'no-issue-activity'
+        stale-pr-label: 'no-pr-activity'

.github/workflows/template-sync.yml

@@ -28,4 +28,4 @@ jobs:
         uses: AndreasAugustin/actions-template-sync@v2
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          source_repo_path: HoleInOneStudios/Repo-Template
+          source_repo_path: HoleInOneStudios/Repo-Template

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 HoleInOneStudios
+Copyright (c) 2023 HoleInOneStudios
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal