Skip to content

Commit bc16125

Browse files
author
mtctx
committed
Initial commit
0 parents  commit bc16125

45 files changed

Lines changed: 2654 additions & 0 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: "🐛 Bug Report"
3+
about: Report a bug to help us improve Squishy.
4+
title: "[BUG] "
5+
labels: [ "bug" ]
6+
assignees: ""
7+
---
8+
9+
**Is your bug report related to a problem? Please describe.**
10+
A clear and concise description of what the bug is. For example, "When I do X, the client crashes."
11+
12+
**Steps to Reproduce**
13+
Steps to reproduce the behavior:
14+
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Actual behavior**
24+
A clear and concise description of what actually happens.
25+
26+
**Screenshots/Videos**
27+
If applicable, add screenshots or a video to help explain your problem.
28+
29+
**Environment**
30+
Please provide the following information:
31+
32+
- **Operating System:** [e.g., Windows 11, macOS, Linux]
33+
- **Java Version:** [e.g., JDK 21]
34+
- **Squishy Version:** [e.g., `v1.0.0-alpha`, commit hash `abcde123`]
35+
- **Squishy Module:** [e.g., `core v1.0.0-alpha+XXX`, commit hash `fghij456`]
36+
37+
**Additional context**
38+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Ask a question
4+
url: mailto:squishy@mtctx.dev
5+
about: Ask a question or get help via E-Mail.

‎.github/ISSUE_TEMPLATE/docs_improvement.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: "✍️ Documentation Improvement"
3+
about: Suggest an improvement to the Squishy's documentation.
4+
title: "[DOCS] "
5+
labels: [ "documentation" ]
6+
assignees: ""
7+
---
8+
9+
**What part of the documentation needs improvement?**
10+
Provide a link to the specific page or file (e.g., `CONTRIBUTING.md`).
11+
12+
**Describe the problem**
13+
A clear and concise description of what is wrong or unclear with the current documentation. (e.g., "There's a typo in X
14+
section" or "The instructions for Y are confusing.")
15+
16+
**Describe the solution you'd like**
17+
A clear and concise description of what the improved documentation should look like.
18+
19+
**Additional context**
20+
Add any other context about the documentation here.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
name: "🚀 Feature Request"
3+
about: Suggest an idea or new feature for Squishy.
4+
title: "[FEATURE] "
5+
labels: [ "enhancement" ]
6+
assignees: ""
7+
---
8+
9+
**Is your feature request related to a problem? Please describe.**
10+
A clear and concise description of what the problem is. For example, "I'm always frustrated when I have to..."
11+
12+
**Describe the solution you'd like**
13+
A clear and concise description of what you want to happen. Explain your proposed solution.
14+
15+
**For which modules should this feature exist?**
16+
A list of all modules which should have this feature (e.g. core, paper, ..)
17+
18+
**Describe alternatives you've considered**
19+
A clear and concise description of any alternative solutions or features you have considered.
20+
21+
**Additional context**
22+
Add any other context or screenshots about the feature request here.

‎.github/ISSUE_TEMPLATE/question.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: "❓ Question / Help"
3+
about: Ask a question about using Squishy or get help with a problem that isn't a bug.
4+
title: "[QUESTION] "
5+
labels: [ "question" ]
6+
assignees: ""
7+
---
8+
9+
**Is your question about a bug or a new feature?**
10+
11+
- If it's a bug, please use the **Bug Report** template.
12+
- If it's a new feature, please use the **Feature Request** template.
13+
14+
**What is your question about?**
15+
Please describe what you are trying to do, what you have tried so far, and what you are stuck on.
16+
17+
**Additional context**
18+
Add any other information that might be helpful. For example, your operating system, Java version, or any relevant
19+
configuration files.

‎.github/pull_request_template.md‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
name: 'Pull Request'
3+
about: Submit a code contribution to the project.
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
---
8+
9+
## Description
10+
11+
Please include a summary of the change and which issue is addressed.
12+
A detailed description of the changes helps reviewers understand the context and purpose of the PR.
13+
14+
**This PR resolves / addresses the following issue(s):**
15+
16+
- Closes # (replace with issue number)
17+
18+
## Type of change
19+
20+
Please delete options that are not relevant.
21+
22+
- [ ] Bug fix (non-breaking change which fixes an issue)
23+
- [ ] New feature (non-breaking change which adds functionality)
24+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
25+
- [ ] Documentation update
26+
- [ ] Code style update (e.g., reformatting, no functional changes)
27+
- [ ] Build process update (e.g., changes to `gradle.kts` files)
28+
29+
## How Has This Been Tested?
30+
31+
Please describe the tests that you ran to verify your changes.
32+
Provide instructions so we can reproduce the testing if needed.
33+
Also list any relevant details for your test configuration.
34+
35+
- [ ] Manually tested on [Your OS here]
36+
- [ ] Added unit tests
37+
- [ ] Added integration tests
38+
39+
## Checklist
40+
41+
Please ensure you have completed all of the following items before submitting your PR.
42+
43+
- [ ] I have read the **[CONTRIBUTING.md](CONTRIBUTING.md)** and **[CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md)** files.
44+
- [ ] I have followed the code style of this project.
45+
- [ ] My code is well-commented, particularly in hard-to-understand areas.
46+
- [ ] I have made corresponding changes to the documentation (if applicable).
47+
- [ ] My changes do not introduce any new warnings or errors.
48+
- [ ] My changes pass the existing tests and I have added new tests where necessary.
49+
- [ ] I have checked my code for any sensitive information or credentials.
50+
- [ ] I have checked my PR title and description for clarity and completeness.

‎.github/workflows/dokka_deploy.yml‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: Deploy Dokka Documentation
2+
3+
on:
4+
workflow_dispatch:
5+
push:
6+
branches:
7+
- main
8+
9+
permissions:
10+
contents: read
11+
pages: write
12+
id-token: write
13+
14+
jobs:
15+
build:
16+
runs-on: ubuntu-latest
17+
steps:
18+
- name: Checkout repository
19+
uses: actions/checkout@v4
20+
with:
21+
fetch-depth: 0
22+
23+
- name: Setup JDK 21
24+
uses: actions/setup-java@v4
25+
with:
26+
java-version: '21'
27+
distribution: 'temurin'
28+
29+
- name: Setup Gradle
30+
uses: gradle/actions/setup-gradle@v3
31+
32+
- name: Generate Dokka documentation
33+
run: ./gradlew dokkaGenerateHtml
34+
35+
- name: Upload artifact
36+
uses: actions/upload-pages-artifact@v3
37+
with:
38+
path: docs/html
39+
40+
deploy:
41+
environment:
42+
name: github-pages
43+
url: ${{ steps.deployment.outputs.page_url }}
44+
runs-on: ubuntu-latest
45+
needs: build
46+
steps:
47+
- name: Deploy to GitHub Pages
48+
id: deployment
49+
uses: actions/deploy-pages@v4

‎.gitignore‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
.gradle
2+
build/
3+
!gradle/wrapper/gradle-wrapper.jar
4+
!**/src/main/**/build/
5+
!**/src/test/**/build/
6+
7+
### IntelliJ IDEA ###
8+
.idea/
9+
!.idea/copyright
10+
*.iws
11+
*.iml
12+
*.ipr
13+
out/
14+
!**/src/main/**/out/
15+
!**/src/test/**/out/
16+
17+
### Kotlin ###
18+
.kotlin
19+
20+
### Eclipse ###
21+
.apt_generated
22+
.classpath
23+
.factorypath
24+
.project
25+
.settings
26+
.springBeans
27+
.sts4-cache
28+
bin/
29+
!**/src/main/**/bin/
30+
!**/src/test/**/bin/
31+
32+
### NetBeans ###
33+
/nbproject/private/
34+
/nbbuild/
35+
/dist/
36+
/nbdist/
37+
/.nb-gradle/
38+
39+
### VS Code ###
40+
.vscode/
41+
42+
### Mac OS ###
43+
.DS_Store

‎.idea/.gitignore‎

Lines changed: 8 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎.idea/copyright/AGPL_v3.xml‎

Lines changed: 6 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)