Initial commit

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,122 @@
+# Code of Conduct
+
+## 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 act and interact 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:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, 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
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* 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
+
+## 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.
+
+## 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.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported
+to the community leaders responsible for enforcement in the project's **Issues** section.
+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.
+
+## 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.
+
+### 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.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant](https://contributor-covenant.org),
+version 2.0, available at https://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).
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://contributor-covenant.org/faq. Translations are available at
+https://contributor-covenant.org/translations.

.github/CONTRIBUTING.md

@@ -0,0 +1,38 @@
+# Contribution Guidelines
+
+Thank you for considering contributing to this project. Your help is appreciated.
+
+## Code of Conduct
+
+This project and everyone participating in it is governed by the project's [Code of Conduct](CODE_OF_CONDUCT.md).
+
+By participating, you are expected to uphold this code.
+
+## How Can I Contribute?
+
+### Reporting Bugs
+
+This section guides you through submitting a bug report for this project. Following these guidelines helps maintainers
+and the community understand your report, reproduce the behavior, and find related reports.
+
+- Use a clear and descriptive title for the issue to identify the problem.
+- Describe the exact steps which reproduce the problem in as many details as possible.
+- Provide specific examples to demonstrate the steps.
+
+### Suggesting Features
+
+This section guides you through submitting a feature request for this project,
+including completely new features and minor improvements to existing functionality.
+
+- Use a clear and descriptive title for the issue to identify the suggestion.
+- Provide a step-by-step description of the suggested improvement in as many details as possible.
+- Provide specific examples to demonstrate the steps.
+
+### Pull Requests
+
+- Fill in the required template.
+- Include screenshots in your pull request whenever possible.
+- Make sure your code follows the project's coding standards.
+- Make sure all tests pass.
+
+Thank you for reading, and we look forward to your contributions!

.github/ISSUE_TEMPLATE/bug-report.md

@@ -0,0 +1,37 @@
+---
+name: Report a bug
+about: Create a report to help us improve.
+title: ''
+labels: 'bug'
+assignees: 'Foulest' # TODO: Change this to your username
+
+---
+
+**Before you submit this, please make sure you have done the following:**
+
+- [ ] I am using the latest version of this project
+- [ ] I have checked the existing documentation for this project
+- [ ] I have searched the issue tracker for a similar issue
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Actual behavior**
+A clear and concise description of what actually happened.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Screenshots**
+If applicable, add screenshots or animated GIFs to help explain your problem.
+
+**Additional context**
+Add any other context about the issue here.

.github/ISSUE_TEMPLATE/documentation-improvement.md

@@ -0,0 +1,23 @@
+---
+name: Documentation improvement
+about: Suggest an improvement for the project documentation.
+title: ''
+labels: 'documentation'
+assignees: 'Foulest' # TODO: Change this to your username
+
+---
+
+**Before you submit this, please make sure you have done the following:**
+
+- [ ] I am using the latest version of this project
+- [ ] I have checked the existing documentation for this project
+- [ ] I have searched the issue tracker for a similar issue
+
+**Describe the issue with the documentation**
+A clear and concise description of what the issue is.
+
+**Suggest how to fix or improve the documentation**
+Steps or details on how to improve the documentation.
+
+**Additional context**
+Add any other context about the issue here.

.github/ISSUE_TEMPLATE/feature-request.md

@@ -0,0 +1,26 @@
+---
+name: Feature request
+about: Suggest an idea for this project.
+title: ''
+labels: 'request'
+assignees: 'Foulest' # TODO: Change this to your username
+
+---
+
+**Before you submit this, please make sure you have done the following:**
+
+- [ ] I am using the latest version of this project
+- [ ] I have checked the existing documentation for this project
+- [ ] I have searched the issue tracker for a similar issue
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context about the issue here.

.github/ISSUE_TEMPLATE/question.md

@@ -0,0 +1,20 @@
+---
+name: Ask a question
+about: Ask a question about the project.
+title: ''
+labels: 'question'
+assignees: 'Foulest' # TODO: Change this to your username
+
+---
+
+**Before you submit this, please make sure you have done the following:**
+
+- [ ] I am using the latest version of this project
+- [ ] I have checked the existing documentation for this project
+- [ ] I have searched the issue tracker for a similar issue
+
+**Your Question**
+Write your question here. Please provide as much detail as possible.
+
+**Additional context**
+Add any other context about the issue here.

.github/SECURITY.md

@@ -0,0 +1,22 @@
+# Security Policy
+
+> **Note:** Only the most recent version of this project is supported with security updates.
+>
+> If you are using an older version, please update to the latest version.
+
+## Reporting a Vulnerability
+
+If you discover a vulnerability, please report it using the project's **Security** section.
+
+When reporting a vulnerability, please provide as much information as possible to help us understand the nature and
+scope of the potential issue. This should include:
+
+- A clear and detailed description of the issue
+- Steps to reproduce the issue, if applicable
+- The version of the project you are using
+- Any other relevant information
+
+We take all disclosures seriously and will do our best to address any issues in a timely manner.
+Please do not disclose the vulnerability publicly until we've had a chance to address it.
+
+Thank you for helping to keep this project and its users safe!

.github/dependabot.yml

@@ -0,0 +1,11 @@
+# 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: "gradle" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "daily" # Check for updates daily

.github/pull_request_template.md

@@ -0,0 +1,16 @@
+**Checklist**
+
+- [ ] I have read the [Contribution Guidelines](CONTRIBUTING.md).
+- [ ] I have searched the issue tracker for a similar issue.
+- [ ] I have added necessary documentation (if appropriate).
+- [ ] I have performed a self-review of my code.
+- [ ] My changes generate no new warnings or errors.
+
+**Related Issue(s)**
+Please link to the issue(s) this pull request is related to, if any.
+
+**Change(s) Made**
+A clear and concise description of what you changed.
+
+**Additional Context**
+Add any other context about the pull request here.

.github/workflows/build.yml

@@ -0,0 +1,31 @@
+name: 'Build Project'
+
+on:
+  push:
+    branches: [ 'main' ]
+  pull_request:
+    branches: [ 'main' ]
+
+jobs:
+  build:
+    name: 'Build Project'
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: 'Checkout Repository'
+        uses: actions/checkout@v4
+
+      - name: 'Setup Java'
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'temurin'
+          java-version: 8 # TODO: Change this to your Java version
+
+      - name: 'Setup Gradle'
+        uses: gradle/actions/setup-gradle@v3
+
+      - name: 'Apply Permissions to Gradlew'
+        run: chmod +x gradlew
+
+      - name: 'Build with Gradle'
+        run: ./gradlew build

.github/workflows/dependency-review.yml

@@ -0,0 +1,27 @@
+# Dependency Review Action
+#
+# This Action will scan dependency manifest files that change as part of a Pull Request,
+# surfacing known-vulnerable versions of the packages declared or updated in the PR.
+# Once installed, if the workflow run is marked as required,
+# PRs introducing known-vulnerable packages will be blocked from merging.
+#
+# Source repository: https://github.com/actions/dependency-review-action
+# Public documentation: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review#dependency-review-enforcement
+name: 'Dependency Review'
+
+on: [ pull_request ]
+
+permissions:
+  contents: read
+
+jobs:
+  dependency-review:
+    name: 'Dependency Review'
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: 'Checkout Repository'
+        uses: actions/checkout@v4
+
+      - name: 'Dependency Review'
+        uses: actions/dependency-review-action@v4